Utils.h

Go to the documentation of this file.

//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
///
/// \file
/// This file contains general utility functions and helpers used across the
/// clang-doc tool, including string manipulation and path handling. It
/// provides lightweight utilities that do not depend on the core clang-doc
/// data model.
///
//===----------------------------------------------------------------------===//
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_FILE_H
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_FILE_H
 
#include "../Representation.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/StringRef.h"
 
/// Appends \p Path to \p Base and returns the appended path.
llvm::SmallString<128> appendPathNative(llvm::StringRef Base,
                                        llvm::StringRef Path);
 
/// Appends \p Path to \p Base and returns the appended path in posix style.
llvm::SmallString<128> appendPathPosix(llvm::StringRef Base,
                                       llvm::StringRef Path);
 
void getHtmlFiles(llvm::StringRef AssetsPath,
                  clang::doc::ClangDocContext &CDCtx);
 
void getMdFiles(llvm::StringRef AssetsPath, clang::doc::ClangDocContext &CDCtx);
 
#endif