blob: ba0ef64d3d0f5f9aed52770328bc4aec968c475b [file] [log] [blame]
//===-- Generators.h - ClangDoc Generator ----------------------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// Generator classes for converting declaration information into documentation
// in a specified format.
#include "Representation.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/Registry.h"
namespace clang {
namespace doc {
// Abstract base class for generators.
// This is expected to be implemented and exposed via the GeneratorRegistry.
class Generator {
virtual ~Generator() = default;
// Write out the decl info for the objects in the given map in the specified
// format.
virtual llvm::Error
generateDocs(StringRef RootDir,
llvm::StringMap<std::unique_ptr<doc::Info>> Infos,
const ClangDocContext &CDCtx) = 0;
// This function writes a file with the index previously constructed.
// It can be overwritten by any of the inherited generators.
// If the override method wants to run this it should call
// Generator::createResources(CDCtx);
virtual llvm::Error createResources(ClangDocContext &CDCtx);
// Write out one specific decl info to the destination stream.
virtual llvm::Error generateDocForInfo(Info *I, llvm::raw_ostream &OS,
const ClangDocContext &CDCtx) = 0;
static void addInfoToIndex(Index &Idx, const doc::Info *Info);
typedef llvm::Registry<Generator> GeneratorRegistry;
findGeneratorByName(llvm::StringRef Format);
std::string getTagType(TagTypeKind AS);
} // namespace doc
} // namespace clang