#include "Generators.h"#include "Representation.h"#include "llvm/ADT/ArrayRef.h"#include "llvm/ADT/StringRef.h"#include "llvm/Support/FileSystem.h"#include "llvm/Support/FormatVariadic.h"#include "llvm/Support/Path.h"#include "llvm/Support/raw_ostream.h"#include <string>Go to the source code of this file.
Classes | |
| class | TableCommentWriter |
| Writer for writing comments to a table cell in MD. More... | |
Namespaces | |
| namespace | clang |
| ===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===// | |
| namespace | clang::doc |
Functions | |
| static std::string | genItalic (const Twine &Text) |
| static std::string | genEmphasis (const Twine &Text) |
| static std::string | genReferenceList (llvm::ArrayRef< Reference > Refs) |
| static void | writeLine (const Twine &Text, raw_ostream &OS) |
| static void | writeNewLine (raw_ostream &OS) |
| static void | writeHeader (const Twine &Text, unsigned int Num, raw_ostream &OS) |
| static void | writeSourceFileRef (const ClangDocContext &CDCtx, const Location &L, raw_ostream &OS) |
| static void | maybeWriteSourceFileRef (llvm::raw_ostream &OS, const ClangDocContext &CDCtx, const std::optional< Location > &DefLoc) |
| static void | writeDescription (const CommentInfo &I, raw_ostream &OS) |
| static void | writeNameLink (const StringRef &CurrentPath, const Reference &R, llvm::raw_ostream &OS) |
| static void | genMarkdown (const ClangDocContext &CDCtx, const EnumInfo &I, llvm::raw_ostream &OS) |
| static void | genMarkdown (const ClangDocContext &CDCtx, const FunctionInfo &I, llvm::raw_ostream &OS) |
| static void | genMarkdown (const ClangDocContext &CDCtx, const NamespaceInfo &I, llvm::raw_ostream &OS) |
| static void | genMarkdown (const ClangDocContext &CDCtx, const RecordInfo &I, llvm::raw_ostream &OS) |
| static void | genMarkdown (const ClangDocContext &CDCtx, const TypedefInfo &I, llvm::raw_ostream &OS) |
| static void | serializeReference (llvm::raw_fd_ostream &OS, const Index &I, int Level) |
| static llvm::Error | serializeIndex (ClangDocContext &CDCtx) |
| static llvm::Error | genIndex (ClangDocContext &CDCtx) |
| static GeneratorRegistry::Add< MDGenerator > | MD (MDGenerator::Format, "Generator for MD output.") |
Function Documentation
◆ genEmphasis()
|
static |
Definition at line 28 of file MDGenerator.cpp.
Referenced by writeDescription().
◆ genIndex()
|
static |
Definition at line 443 of file MDGenerator.cpp.
References clang::doc::Index::getSortedChildren(), clang::doc::ClangDocContext::Idx, clang::doc::IT_concept, clang::doc::IT_default, clang::doc::IT_enum, clang::doc::IT_friend, clang::doc::IT_function, clang::doc::IT_namespace, clang::doc::IT_record, clang::doc::IT_typedef, clang::doc::IT_variable, clang::doc::ClangDocContext::OutDirectory, clang::doc::ClangDocContext::ProjectName, and clang::doc::Index::sort().
◆ genItalic()
|
static |
Definition at line 24 of file MDGenerator.cpp.
Referenced by genMarkdown().
◆ genMarkdown() [1/5]
|
static |
Definition at line 229 of file MDGenerator.cpp.
References clang::doc::EnumInfo::BaseType, clang::doc::SymbolInfo::DefLoc, clang::doc::Info::Description, maybeWriteSourceFileRef(), clang::doc::EnumInfo::Members, clang::doc::Info::Name, clang::doc::EnumInfo::Scoped, TableCommentWriter::write(), and writeDescription().
Referenced by genMarkdown(), and genMarkdown().
◆ genMarkdown() [2/5]
|
static |
Definition at line 275 of file MDGenerator.cpp.
References clang::doc::FunctionInfo::Access, clang::doc::SymbolInfo::DefLoc, clang::doc::Info::Description, genItalic(), clang::doc::SymbolInfo::IsStatic, maybeWriteSourceFileRef(), clang::doc::Info::Name, clang::doc::FunctionInfo::Params, clang::doc::Reference::QualName, clang::doc::FunctionInfo::ReturnType, clang::doc::TypeInfo::Type, writeDescription(), writeHeader(), and writeLine().
◆ genMarkdown() [3/5]
|
static |
Definition at line 300 of file MDGenerator.cpp.
References clang::doc::NamespaceInfo::Children, clang::doc::Info::Description, clang::doc::ScopeChildren::Enums, clang::doc::ScopeChildren::Functions, genMarkdown(), clang::doc::Info::getRelativeFilePath(), clang::doc::Info::Name, clang::doc::ScopeChildren::Namespaces, clang::doc::ScopeChildren::Records, writeDescription(), writeHeader(), writeNameLink(), and writeNewLine().
◆ genMarkdown() [4/5]
|
static |
Definition at line 350 of file MDGenerator.cpp.
References clang::doc::RecordInfo::Children, clang::doc::SymbolInfo::DefLoc, clang::doc::Info::Description, clang::doc::ScopeChildren::Enums, clang::doc::ScopeChildren::Functions, genMarkdown(), genReferenceList(), clang::doc::getTagType(), maybeWriteSourceFileRef(), clang::doc::RecordInfo::Members, clang::doc::Info::Name, clang::doc::RecordInfo::Parents, clang::doc::ScopeChildren::Records, clang::doc::RecordInfo::TagType, clang::doc::RecordInfo::VirtualParents, writeDescription(), writeHeader(), writeLine(), and writeNewLine().
◆ genMarkdown() [5/5]
|
static |
Definition at line 406 of file MDGenerator.cpp.
◆ genReferenceList()
|
static |
Definition at line 32 of file MDGenerator.cpp.
Referenced by genMarkdown().
◆ maybeWriteSourceFileRef()
|
static |
Definition at line 142 of file MDGenerator.cpp.
References writeSourceFileRef().
Referenced by genMarkdown(), genMarkdown(), and genMarkdown().
◆ MD()
|
static |
Referenced by clang::tidy::bugprone::ComparePointerToMemberVirtualFunctionCheck::check(), clang::tidy::misc::DefinitionsInHeadersCheck::check(), clang::tidy::misc::NewDeleteOverloadsCheck::check(), clang::clangd::CollectMainFileMacros::Defined(), clang::clangd::CollectMainFileMacros::Elifdef(), clang::tidy::modernize::MacroToEnumCallbacks::Elifdef(), clang::clangd::CollectMainFileMacros::Elifndef(), clang::tidy::modernize::MacroToEnumCallbacks::Elifndef(), clang::tidy::misc::hasCorrespondingOverloadInBaseClass(), clang::clangd::CollectMainFileMacros::Ifdef(), clang::find_all_symbols::FindAllMacros::Ifdef(), clang::tidy::modernize::MacroToEnumCallbacks::Ifdef(), clang::clangd::CollectMainFileMacros::Ifndef(), clang::find_all_symbols::FindAllMacros::Ifndef(), clang::tidy::modernize::MacroToEnumCallbacks::Ifndef(), clang::tidy::bugprone::isOverrideMethod(), clang::tidy::misc::isOverrideMethod(), clang::clangd::CollectMainFileMacros::MacroDefined(), clang::find_all_symbols::FindAllMacros::MacroDefined(), clang::tidy::modernize::MacroToEnumCallbacks::MacroDefined(), clang::clangd::CollectMainFileMacros::MacroExpands(), clang::find_all_symbols::FindAllMacros::MacroExpands(), clang::clangd::CollectMainFileMacros::MacroUndefined(), clang::tidy::modernize::MacroToEnumCallbacks::MacroUndefined(), clang::clangd::nameLocation(), clang::tidy::misc::NewDeleteOverloadsCheck::onEndOfTranslationUnit(), clang::tidy::utils::refersToEnclosingLambdaCaptureByRef(), clang::tidy::cppcoreguidelines::MacroUsageCheck::warnMacro(), clang::tidy::cppcoreguidelines::MacroUsageCheck::warnNaming(), and clang::tooling::ExpandModularHeadersPPCallbacks::~ExpandModularHeadersPPCallbacks().
◆ serializeIndex()
|
static |
Definition at line 419 of file MDGenerator.cpp.
References clang::doc::Index::getSortedChildren(), clang::doc::ClangDocContext::Idx, clang::doc::ClangDocContext::OutDirectory, clang::doc::ClangDocContext::ProjectName, serializeReference(), and clang::doc::Index::sort().
◆ serializeReference()
|
static |
Definition at line 411 of file MDGenerator.cpp.
References writeNameLink().
Referenced by serializeIndex().
◆ writeDescription()
|
static |
Definition at line 149 of file MDGenerator.cpp.
References clang::doc::CommentInfo::AttrKeys, clang::doc::CommentInfo::AttrValues, clang::doc::CommentInfo::Children, clang::doc::CK_BlockCommandComment, clang::doc::CK_FullComment, clang::doc::CK_HTMLEndTagComment, clang::doc::CK_HTMLStartTagComment, clang::doc::CK_InlineCommandComment, clang::doc::CK_ParagraphComment, clang::doc::CK_ParamCommandComment, clang::doc::CK_TextComment, clang::doc::CK_TParamCommandComment, clang::doc::CK_Unknown, clang::doc::CK_VerbatimBlockComment, clang::doc::CK_VerbatimBlockLineComment, clang::doc::CK_VerbatimLineComment, clang::doc::CommentInfo::Direction, clang::doc::CommentInfo::Explicit, genEmphasis(), clang::doc::CommentInfo::Kind, clang::doc::CommentInfo::Name, clang::doc::CommentInfo::ParamName, clang::doc::CommentInfo::SelfClosing, clang::doc::CommentInfo::Text, writeDescription(), writeLine(), and writeNewLine().
Referenced by genMarkdown(), genMarkdown(), genMarkdown(), genMarkdown(), and writeDescription().
◆ writeHeader()
|
static |
Definition at line 49 of file MDGenerator.cpp.
Referenced by genMarkdown(), genMarkdown(), and genMarkdown().
◆ writeLine()
|
static |
Definition at line 43 of file MDGenerator.cpp.
Referenced by genMarkdown(), genMarkdown(), and writeDescription().
◆ writeNameLink()
|
static |
Definition at line 219 of file MDGenerator.cpp.
References clang::doc::Reference::getFileBaseName(), clang::doc::Reference::getRelativeFilePath(), and clang::doc::Reference::Name.
Referenced by genMarkdown(), and serializeReference().
◆ writeNewLine()
|
static |
Definition at line 47 of file MDGenerator.cpp.
Referenced by genMarkdown(), genMarkdown(), and writeDescription().
◆ writeSourceFileRef()
|
static |
Definition at line 53 of file MDGenerator.cpp.
References clang::doc::Location::Filename, clang::doc::ClangDocContext::RepositoryLinePrefix, clang::doc::ClangDocContext::RepositoryUrl, and clang::doc::Location::StartLineNumber.
Referenced by maybeWriteSourceFileRef().
Generated on for clang-tools by
1.14.0