[clang] 32056aa - [docs] Fix doxygen markers for grouping methods. NFC.
Volodymyr Sapsai via cfe-commits
cfe-commits at lists.llvm.org
Thu Aug 3 11:16:54 PDT 2023
Author: Volodymyr Sapsai
Date: 2023-08-03T11:16:42-07:00
New Revision: 32056aa3443786822963e6e469d98deb7b857d79
URL: https://github.com/llvm/llvm-project/commit/32056aa3443786822963e6e469d98deb7b857d79
DIFF: https://github.com/llvm/llvm-project/commit/32056aa3443786822963e6e469d98deb7b857d79.diff
LOG: [docs] Fix doxygen markers for grouping methods. NFC.
Added:
Modified:
clang/include/clang/Frontend/CompilerInstance.h
Removed:
################################################################################
diff --git a/clang/include/clang/Frontend/CompilerInstance.h b/clang/include/clang/Frontend/CompilerInstance.h
index c6af1fd5dd010f..377055e8f6f924 100644
--- a/clang/include/clang/Frontend/CompilerInstance.h
+++ b/clang/include/clang/Frontend/CompilerInstance.h
@@ -189,7 +189,7 @@ class CompilerInstance : public ModuleLoader {
~CompilerInstance() override;
/// @name High-Level Operations
- /// {
+ /// @{
/// ExecuteAction - Execute the provided action against the compiler's
/// CompilerInvocation object.
@@ -223,9 +223,9 @@ class CompilerInstance : public ModuleLoader {
/// Load the list of plugins requested in the \c FrontendOptions.
void LoadRequestedPlugins();
- /// }
+ /// @}
/// @name Compiler Invocation and Options
- /// {
+ /// @{
bool hasInvocation() const { return Invocation != nullptr; }
@@ -248,9 +248,9 @@ class CompilerInstance : public ModuleLoader {
BuildGlobalModuleIndex = Build;
}
- /// }
+ /// @}
/// @name Forwarding Methods
- /// {
+ /// @{
AnalyzerOptionsRef getAnalyzerOpts() {
return Invocation->getAnalyzerOpts();
@@ -329,9 +329,9 @@ class CompilerInstance : public ModuleLoader {
return Invocation->getTargetOpts();
}
- /// }
+ /// @}
/// @name Diagnostics Engine
- /// {
+ /// @{
bool hasDiagnostics() const { return Diagnostics != nullptr; }
@@ -355,9 +355,9 @@ class CompilerInstance : public ModuleLoader {
return *Diagnostics->getClient();
}
- /// }
+ /// @}
/// @name VerboseOutputStream
- /// }
+ /// @{
/// Replace the current stream for verbose output.
void setVerboseOutputStream(raw_ostream &Value);
@@ -370,9 +370,9 @@ class CompilerInstance : public ModuleLoader {
return *VerboseOutputStream;
}
- /// }
+ /// @}
/// @name Target Info
- /// {
+ /// @{
bool hasTarget() const { return Target != nullptr; }
@@ -389,9 +389,9 @@ class CompilerInstance : public ModuleLoader {
/// Replace the current Target.
void setTarget(TargetInfo *Value);
- /// }
+ /// @}
/// @name AuxTarget Info
- /// {
+ /// @{
TargetInfo *getAuxTarget() const { return AuxTarget.get(); }
@@ -401,15 +401,15 @@ class CompilerInstance : public ModuleLoader {
// Create Target and AuxTarget based on current options
bool createTarget();
- /// }
+ /// @}
/// @name Virtual File System
- /// {
+ /// @{
llvm::vfs::FileSystem &getVirtualFileSystem() const;
- /// }
+ /// @}
/// @name File Manager
- /// {
+ /// @{
bool hasFileManager() const { return FileMgr != nullptr; }
@@ -432,9 +432,9 @@ class CompilerInstance : public ModuleLoader {
/// Replace the current file manager and virtual file system.
void setFileManager(FileManager *Value);
- /// }
+ /// @}
/// @name Source Manager
- /// {
+ /// @{
bool hasSourceManager() const { return SourceMgr != nullptr; }
@@ -457,9 +457,9 @@ class CompilerInstance : public ModuleLoader {
/// setSourceManager - Replace the current source manager.
void setSourceManager(SourceManager *Value);
- /// }
+ /// @}
/// @name Preprocessor
- /// {
+ /// @{
bool hasPreprocessor() const { return PP != nullptr; }
@@ -478,9 +478,9 @@ class CompilerInstance : public ModuleLoader {
/// Replace the current preprocessor.
void setPreprocessor(std::shared_ptr<Preprocessor> Value);
- /// }
+ /// @}
/// @name ASTContext
- /// {
+ /// @{
bool hasASTContext() const { return Context != nullptr; }
@@ -506,9 +506,9 @@ class CompilerInstance : public ModuleLoader {
/// of S.
void setSema(Sema *S);
- /// }
+ /// @}
/// @name ASTConsumer
- /// {
+ /// @{
bool hasASTConsumer() const { return (bool)Consumer; }
@@ -525,9 +525,9 @@ class CompilerInstance : public ModuleLoader {
/// takes ownership of \p Value.
void setASTConsumer(std::unique_ptr<ASTConsumer> Value);
- /// }
+ /// @}
/// @name Semantic analysis
- /// {
+ /// @{
bool hasSema() const { return (bool)TheSema; }
Sema &getSema() const {
@@ -538,9 +538,9 @@ class CompilerInstance : public ModuleLoader {
std::unique_ptr<Sema> takeSema();
void resetAndLeakSema();
- /// }
+ /// @}
/// @name Module Management
- /// {
+ /// @{
IntrusiveRefCntPtr<ASTReader> getASTReader() const;
void setASTReader(IntrusiveRefCntPtr<ASTReader> Reader);
@@ -581,9 +581,9 @@ class CompilerInstance : public ModuleLoader {
return *Reader;
}
- /// }
+ /// @}
/// @name Code Completion
- /// {
+ /// @{
bool hasCodeCompletionConsumer() const { return (bool)CompletionConsumer; }
@@ -597,9 +597,9 @@ class CompilerInstance : public ModuleLoader {
/// the compiler instance takes ownership of \p Value.
void setCodeCompletionConsumer(CodeCompleteConsumer *Value);
- /// }
+ /// @}
/// @name Frontend timer
- /// {
+ /// @{
bool hasFrontendTimer() const { return (bool)FrontendTimer; }
@@ -608,9 +608,9 @@ class CompilerInstance : public ModuleLoader {
return *FrontendTimer;
}
- /// }
+ /// @}
/// @name Output Files
- /// {
+ /// @{
/// clearOutputFiles - Clear the output file list. The underlying output
/// streams must have been closed beforehand.
@@ -618,9 +618,9 @@ class CompilerInstance : public ModuleLoader {
/// \param EraseFiles - If true, attempt to erase the files from disk.
void clearOutputFiles(bool EraseFiles);
- /// }
+ /// @}
/// @name Construction Utility Methods
- /// {
+ /// @{
/// Create the diagnostics engine using the invocation's diagnostic options
/// and replace any existing one with it.
@@ -769,9 +769,9 @@ class CompilerInstance : public ModuleLoader {
public:
std::unique_ptr<raw_pwrite_stream> createNullOutputFile();
- /// }
+ /// @}
/// @name Initialization Utility Methods
- /// {
+ /// @{
/// InitializeSourceManager - Initialize the source manager to set InputFile
/// as the main file.
@@ -788,7 +788,7 @@ class CompilerInstance : public ModuleLoader {
FileManager &FileMgr,
SourceManager &SourceMgr);
- /// }
+ /// @}
void setOutputStream(std::unique_ptr<llvm::raw_pwrite_stream> OutStream) {
OutputStream = std::move(OutStream);
More information about the cfe-commits
mailing list