forked from OSchip/llvm-project
42 lines
1.3 KiB
C
42 lines
1.3 KiB
C
|
//===-- Generators.h - ClangDoc Generator ----------------------*- C++ -*-===//
|
||
|
|
//
|
||
|
|
// The LLVM Compiler Infrastructure
|
||
|
|
//
|
||
|
|
// This file is distributed under the University of Illinois Open Source
|
||
|
|
// License. See LICENSE.TXT for details.
|
||
|
|
//
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
// Generator classes for converting declaration information into documentation
|
||
|
|
// in a specified format.
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
|
||
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_GENERATOR_H
|
||
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_GENERATOR_H
|
||
|
|
|
||
|
|
#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 {
|
||
|
|
public:
|
||
|
|
virtual ~Generator() = default;
|
||
|
|
|
||
|
|
// Write out the decl info in the specified format.
|
||
|
|
virtual bool generateDocForInfo(Info *I, llvm::raw_ostream &OS) = 0;
|
||
|
|
};
|
||
|
|
|
||
|
|
typedef llvm::Registry<Generator> GeneratorRegistry;
|
||
|
|
|
||
|
|
llvm::Expected<std::unique_ptr<Generator>>
|
||
|
|
findGeneratorByName(llvm::StringRef Format);
|
||
|
|
|
||
|
|
} // namespace doc
|
||
|
|
} // namespace clang
|
||
|
|
|
||
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_GENERATOR_H
|