clang-tools
9.0.0
|
#include "BitcodeReader.h"
#include "BitcodeWriter.h"
#include "ClangDoc.h"
#include "Generators.h"
#include "Representation.h"
#include "clang/AST/AST.h"
#include "clang/AST/Decl.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/ASTMatchers/ASTMatchersInternal.h"
#include "clang/Driver/Options.h"
#include "clang/Frontend/FrontendActions.h"
#include "clang/Tooling/CommonOptionsParser.h"
#include "clang/Tooling/Execution.h"
#include "clang/Tooling/Tooling.h"
#include "llvm/ADT/APFloat.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/Path.h"
#include "llvm/Support/Process.h"
#include "llvm/Support/Signals.h"
#include "llvm/Support/raw_ostream.h"
#include <string>
Go to the source code of this file.
Enumerations | |
enum | OutputFormatTy { md, yaml, html } |
Functions | |
static llvm::cl::extrahelp | CommonHelp (CommonOptionsParser::HelpMessage) |
static llvm::cl::OptionCategory | ClangDocCategory ("clang-doc options") |
static llvm::cl::opt< std::string > | OutDirectory ("output", llvm::cl::desc("Directory for outputting generated files."), llvm::cl::init("docs"), llvm::cl::cat(ClangDocCategory)) |
static llvm::cl::opt< bool > | PublicOnly ("public", llvm::cl::desc("Document only public declarations."), llvm::cl::init(false), llvm::cl::cat(ClangDocCategory)) |
static llvm::cl::opt< bool > | DoxygenOnly ("doxygen", llvm::cl::desc("Use only doxygen-style comments to generate docs."), llvm::cl::init(false), llvm::cl::cat(ClangDocCategory)) |
static llvm::cl::opt< OutputFormatTy > | FormatEnum ("format", llvm::cl::desc("Format for outputted docs."), llvm::cl::values(clEnumValN(OutputFormatTy::yaml, "yaml", "Documentation in YAML format."), clEnumValN(OutputFormatTy::md, "md", "Documentation in MD format."), clEnumValN(OutputFormatTy::html, "html", "Documentation in HTML format.")), llvm::cl::init(OutputFormatTy::yaml), llvm::cl::cat(ClangDocCategory)) |
std::string | getFormatString () |
bool | CreateDirectory (const Twine &DirName, bool ClearDirectory=false) |
llvm::Expected< llvm::SmallString< 128 > > | getInfoOutputFile (StringRef Root, StringRef RelativePath, StringRef Name, StringRef Ext) |
bool | bitcodeResultsToInfos (tooling::ToolResults &Results, llvm::StringMap< std::vector< std::unique_ptr< doc::Info >>> &Output) |
int | main (int argc, const char **argv) |
enum OutputFormatTy |
Enumerator | |
---|---|
md | |
yaml | |
html |
Definition at line 65 of file ClangDocMain.cpp.
bool bitcodeResultsToInfos | ( | tooling::ToolResults & | Results, |
llvm::StringMap< std::vector< std::unique_ptr< doc::Info >>> & | Output | ||
) |
Definition at line 145 of file ClangDocMain.cpp.
|
static |
Referenced by main().
|
static |
bool CreateDirectory | ( | const Twine & | DirName, |
bool | ClearDirectory = false |
||
) |
Definition at line 94 of file ClangDocMain.cpp.
Referenced by getInfoOutputFile().
|
static |
Referenced by main().
|
static |
Referenced by getFormatString().
std::string getFormatString | ( | ) |
Definition at line 82 of file ClangDocMain.cpp.
References FormatEnum(), html, md, and yaml.
Referenced by main().
llvm::Expected<llvm::SmallString<128> > getInfoOutputFile | ( | StringRef | Root, |
StringRef | RelativePath, | ||
StringRef | Name, | ||
StringRef | Ext | ||
) |
Definition at line 128 of file ClangDocMain.cpp.
References CreateDirectory(), and Path.
int main | ( | int | argc, |
const char ** | argv | ||
) |
Definition at line 167 of file ClangDocMain.cpp.
References ClangDocCategory(), DoxygenOnly(), clang::doc::findGeneratorByName(), getFormatString(), PublicOnly(), and clang::tidy::cppcoreguidelines::toString().
|
static |
|
static |
Referenced by main().