Generator for YAML documentation. More...
Inheritance diagram for clang::doc::YAMLGenerator:
Public Member Functions | |
| llvm::Error | generateDocs (StringRef RootDir, llvm::StringMap< std::unique_ptr< doc::Info > > Infos, const ClangDocContext &CDCtx) override |
| llvm::Error | generateDocForInfo (Info *I, llvm::raw_ostream &OS, const ClangDocContext &CDCtx) override |
 Public Member Functions inherited from clang::doc::Generator | |
| virtual | ~Generator ()=default |
| virtual llvm::Error | generateDocs (StringRef RootDir, llvm::StringMap< std::unique_ptr< doc::Info > > Infos, const ClangDocContext &CDCtx)=0 |
| virtual llvm::Error | createResources (ClangDocContext &CDCtx) |
| virtual llvm::Error | generateDocForInfo (Info *I, llvm::raw_ostream &OS, const ClangDocContext &CDCtx)=0 |
Static Public Attributes | |
| static const char * | Format = "yaml" |
Additional Inherited Members | |
| Static Public Member Functions inherited from clang::doc::Generator | |
| static void | addInfoToIndex (Index &Idx, const doc::Info *Info) |
Detailed Description
Generator for YAML documentation.
Definition at line 318 of file YAMLGenerator.cpp.
Member Function Documentation
◆ generateDocForInfo()
|
overridevirtual |
Implements clang::doc::Generator.
Definition at line 364 of file YAMLGenerator.cpp.
References clang::doc::Info::IT, clang::doc::IT_default, clang::doc::IT_enum, clang::doc::IT_function, clang::doc::IT_namespace, clang::doc::IT_record, clang::doc::IT_typedef, and OS.
Referenced by generateDocs().
◆ generateDocs()
|
overridevirtual |
Implements clang::doc::Generator.
Definition at line 332 of file YAMLGenerator.cpp.
References generateDocForInfo(), clang::doc::Info::IT, clang::doc::IT_namespace, clang::doc::Info::Name, and Path.
Member Data Documentation
◆ Format
|
static |
Definition at line 320 of file YAMLGenerator.cpp.
The documentation for this class was generated from the following file:
