llvm/clang-tools-extra/clang-doc/MDGenerator.cpp

//===-- MDGenerator.cpp - Markdown Generator --------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include "Generators.h"
#include "Representation.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/Path.h"
#include <string>

usingnamespacellvm;

namespace clang {
namespace doc {

// Markdown generation

static std::string genItalic(const Twine &Text) { … }

static std::string genEmphasis(const Twine &Text) { … }

static std::string
genReferenceList(const llvm::SmallVectorImpl<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 writeFileDefinition(const ClangDocContext &CDCtx, const Location &L,
                                raw_ostream &OS) { … }

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, Index &I, int Level) { … }

static llvm::Error serializeIndex(ClangDocContext &CDCtx) { … }

static llvm::Error genIndex(ClangDocContext &CDCtx) { … }

/// Generator for Markdown documentation.
class MDGenerator : public Generator { … };

const char *MDGenerator::Format = …;

llvm::Error
MDGenerator::generateDocs(StringRef RootDir,
                          llvm::StringMap<std::unique_ptr<doc::Info>> Infos,
                          const ClangDocContext &CDCtx) { … }

llvm::Error MDGenerator::generateDocForInfo(Info *I, llvm::raw_ostream &OS,
                                            const ClangDocContext &CDCtx) { … }

llvm::Error MDGenerator::createResources(ClangDocContext &CDCtx) { … }

static GeneratorRegistry::Add<MDGenerator> MD(MDGenerator::Format,
                                              "Generator for MD output.");

// This anchor is used to force the linker to link in the generated object
// file and thus register the generator.
volatile int MDGeneratorAnchorSource = …;

} // namespace doc
} // namespace clang