clang-tools
7.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/StandaloneExecution.h"
#include "clang/Tooling/Tooling.h"
#include "llvm/ADT/APFloat.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 { yaml } |
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 > | DumpMapperResult ("dump-mapper", llvm::cl::desc("Dump mapper results to bitcode file."), llvm::cl::init(false), llvm::cl::cat(ClangDocCategory)) |
static llvm::cl::opt< bool > | DumpIntermediateResult ("dump-intermediate", llvm::cl::desc("Dump intermediate results to bitcode file."), llvm::cl::init(false), 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< OutputFormatTy > | FormatEnum ("format", llvm::cl::desc("Format for outputted docs."), llvm::cl::values(clEnumVal(yaml, "Documentation in YAML format.")), llvm::cl::init(yaml), 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)) |
bool | CreateDirectory (const Twine &DirName, bool ClearDirectory=false) |
bool | DumpResultToFile (const Twine &DirName, const Twine &FileName, StringRef Buffer, bool ClearDirectory=false) |
llvm::Expected< llvm::SmallString< 128 > > | getPath (StringRef Root, StringRef Ext, StringRef Name, llvm::SmallVectorImpl< doc::Reference > &Namespaces) |
std::string | getFormatString (OutputFormatTy Ty) |
int | main (int argc, const char **argv) |
enum OutputFormatTy |
Enumerator | |
---|---|
yaml |
Definition at line 71 of file ClangDocMain.cpp.
|
static |
Referenced by main().
|
static |
bool CreateDirectory | ( | const Twine & | DirName, |
bool | ClearDirectory = false |
||
) |
Definition at line 85 of file ClangDocMain.cpp.
Referenced by DumpResultToFile(), and getPath().
|
static |
Referenced by main().
|
static |
Referenced by main().
|
static |
Referenced by main().
bool DumpResultToFile | ( | const Twine & | DirName, |
const Twine & | FileName, | ||
StringRef | Buffer, | ||
bool | ClearDirectory = false |
||
) |
Definition at line 104 of file ClangDocMain.cpp.
References CreateDirectory(), and OutDirectory().
Referenced by main().
|
static |
Referenced by main().
std::string getFormatString | ( | OutputFormatTy | Ty | ) |
llvm::Expected<llvm::SmallString<128> > getPath | ( | StringRef | Root, |
StringRef | Ext, | ||
StringRef | Name, | ||
llvm::SmallVectorImpl< doc::Reference > & | Namespaces | ||
) |
Definition at line 125 of file ClangDocMain.cpp.
References CreateDirectory(), and Path.
Referenced by main().
int main | ( | int | argc, |
const char ** | argv | ||
) |
Definition at line 149 of file ClangDocMain.cpp.
References ClangDocCategory(), clang::doc::ClangDocBitcodeWriter::dispatchInfoForWrite(), DoxygenOnly(), DumpIntermediateResult(), DumpMapperResult(), DumpResultToFile(), clang::doc::findGeneratorByName(), FormatEnum(), getFormatString(), getPath(), clang::doc::mergeInfos(), clang::doc::Info::Name, clang::doc::Info::Namespace, clang::doc::newMapperActionFactory(), OutDirectory(), PublicOnly(), clang::doc::ClangDocBitcodeReader::readBitcode(), and clang::tidy::cppcoreguidelines::toString().
|
static |
Referenced by DumpResultToFile(), and main().
|
static |
Referenced by main().