From 9784d093e132f96255c8c943bc082f772235e33a Mon Sep 17 00:00:00 2001 From: James Dennett Date: Mon, 2 Jul 2012 07:01:42 +0000 Subject: [PATCH] Documentation cleanup: reformatting/fixing up file comments so that they have \file and \brief markup and appear in Doxygen's summaries (and eventually at http://clang.llvm.org/doxygen/files.html). Fixed up another couple of minor glitches in the docs at the same time. llvm-svn: 159517 --- clang/include/clang/Basic/ABI.h | 9 +++++---- clang/include/clang/Basic/AddressSpaces.h | 9 +++++---- clang/include/clang/Basic/AllDiagnostics.h | 8 ++++---- clang/include/clang/Basic/AttrKinds.h | 7 ++++--- clang/include/clang/Basic/Builtins.h | 9 +++++---- clang/include/clang/Basic/Diagnostic.h | 7 ++++--- clang/include/clang/Basic/DiagnosticIDs.h | 7 ++++--- .../include/clang/Basic/ExceptionSpecificationType.h | 9 +++++---- clang/include/clang/Basic/ExpressionTraits.h | 7 ++++--- clang/include/clang/Basic/FileManager.h | 7 ++++--- clang/include/clang/Basic/FileSystemOptions.h | 7 ++++--- clang/include/clang/Basic/FileSystemStatCache.h | 7 ++++--- clang/include/clang/Basic/IdentifierTable.h | 9 +++++---- clang/include/clang/Basic/LLVM.h | 7 ++++--- clang/include/clang/Basic/Lambda.h | 8 +++++--- clang/include/clang/Basic/LangOptions.h | 7 ++++--- clang/include/clang/Basic/Linkage.h | 8 ++++---- clang/include/clang/Basic/MacroBuilder.h | 7 ++++--- clang/include/clang/Basic/Module.h | 11 ++++++----- clang/include/clang/Basic/ObjCRuntime.h | 7 ++++--- clang/include/clang/Basic/OnDiskHashTable.h | 8 ++++---- clang/include/clang/Basic/OpenCL.h | 7 ++++--- clang/include/clang/Basic/OperatorKinds.h | 7 ++++--- clang/include/clang/Basic/PartialDiagnostic.h | 9 +++++---- clang/include/clang/Basic/PrettyStackTrace.h | 11 ++++++----- clang/include/clang/Basic/SourceLocation.h | 7 ++++--- clang/include/clang/Basic/SourceManager.h | 7 ++++--- clang/include/clang/Basic/SourceManagerInternals.h | 8 ++++---- clang/include/clang/Basic/Specifiers.h | 9 +++++---- clang/include/clang/Basic/TargetBuiltins.h | 6 ++++++ clang/include/clang/Basic/TargetInfo.h | 7 ++++--- clang/include/clang/Basic/TargetOptions.h | 5 +++++ clang/include/clang/Basic/TemplateKinds.h | 7 ++++--- clang/include/clang/Basic/TokenKinds.h | 7 ++++--- clang/include/clang/Basic/TypeTraits.h | 7 ++++--- clang/include/clang/Basic/Version.h | 9 +++++---- clang/include/clang/Basic/VersionTuple.h | 9 +++++---- clang/include/clang/Basic/Visibility.h | 9 +++++---- 38 files changed, 170 insertions(+), 126 deletions(-) diff --git a/clang/include/clang/Basic/ABI.h b/clang/include/clang/Basic/ABI.h index 018f50026541..9599abe77a5a 100644 --- a/clang/include/clang/Basic/ABI.h +++ b/clang/include/clang/Basic/ABI.h @@ -6,10 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// These enums/classes describe ABI related information about constructors, -// destructors and thunks. -// +/// +/// \file +/// \brief Enums/classes describing ABI related information about constructors, +/// destructors and thunks. +/// //===----------------------------------------------------------------------===// #ifndef CLANG_BASIC_ABI_H diff --git a/clang/include/clang/Basic/AddressSpaces.h b/clang/include/clang/Basic/AddressSpaces.h index 56c0f956f259..b8077ec15102 100644 --- a/clang/include/clang/Basic/AddressSpaces.h +++ b/clang/include/clang/Basic/AddressSpaces.h @@ -6,10 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file provides definitions for the various language-specific address -// spaces. -// +/// +/// \file +/// \brief Provides definitions for the various language-specific address +/// spaces. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_ADDRESSSPACES_H diff --git a/clang/include/clang/Basic/AllDiagnostics.h b/clang/include/clang/Basic/AllDiagnostics.h index 7e774355488c..9f4a25543fd0 100644 --- a/clang/include/clang/Basic/AllDiagnostics.h +++ b/clang/include/clang/Basic/AllDiagnostics.h @@ -6,10 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file includes all the separate Diagnostic headers & some related -// helpers. -// +/// +/// \file +/// \brief Includes all the separate Diagnostic headers & some related helpers. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_ALL_DIAGNOSTICS_H diff --git a/clang/include/clang/Basic/AttrKinds.h b/clang/include/clang/Basic/AttrKinds.h index 9d5ae588c50f..a429336e0603 100644 --- a/clang/include/clang/Basic/AttrKinds.h +++ b/clang/include/clang/Basic/AttrKinds.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the attr::Kind enum -// +/// +/// \file +/// \brief Defines the clang::attr::Kind enum. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_ATTRKINDS_H diff --git a/clang/include/clang/Basic/Builtins.h b/clang/include/clang/Basic/Builtins.h index 5afa02010040..aa6f9f9355f9 100644 --- a/clang/include/clang/Basic/Builtins.h +++ b/clang/include/clang/Basic/Builtins.h @@ -6,10 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines enum values for all the target-independent builtin -// functions. -// +/// +/// \file +/// \brief Defines enum values for all the target-independent builtin +/// functions. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_BUILTINS_H diff --git a/clang/include/clang/Basic/Diagnostic.h b/clang/include/clang/Basic/Diagnostic.h index 4c3649372c1f..361093b9d83f 100644 --- a/clang/include/clang/Basic/Diagnostic.h +++ b/clang/include/clang/Basic/Diagnostic.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the Diagnostic-related interfaces. -// +/// +/// \file +/// \brief Defines the Diagnostic-related interfaces. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_DIAGNOSTIC_H diff --git a/clang/include/clang/Basic/DiagnosticIDs.h b/clang/include/clang/Basic/DiagnosticIDs.h index f00929d85b80..532de5ed0653 100644 --- a/clang/include/clang/Basic/DiagnosticIDs.h +++ b/clang/include/clang/Basic/DiagnosticIDs.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the Diagnostic IDs-related interfaces. -// +/// +/// \file +/// \brief Defines the Diagnostic IDs-related interfaces. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_DIAGNOSTICIDS_H diff --git a/clang/include/clang/Basic/ExceptionSpecificationType.h b/clang/include/clang/Basic/ExceptionSpecificationType.h index e911bde1910a..6be5053b1bcf 100644 --- a/clang/include/clang/Basic/ExceptionSpecificationType.h +++ b/clang/include/clang/Basic/ExceptionSpecificationType.h @@ -6,10 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the ExceptionSpecificationType enumeration and various -// utility functions. -// +/// +/// \file +/// \brief Defines the ExceptionSpecificationType enumeration and various +/// utility functions. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_EXCEPTIONSPECIFICATIONTYPE_H #define LLVM_CLANG_BASIC_EXCEPTIONSPECIFICATIONTYPE_H diff --git a/clang/include/clang/Basic/ExpressionTraits.h b/clang/include/clang/Basic/ExpressionTraits.h index c4e6a1c96f1a..e87771572129 100644 --- a/clang/include/clang/Basic/ExpressionTraits.h +++ b/clang/include/clang/Basic/ExpressionTraits.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines enumerations for expression traits intrinsics. -// +/// +/// \file +/// \brief Defines enumerations for expression traits intrinsics. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_EXPRESSIONTRAITS_H diff --git a/clang/include/clang/Basic/FileManager.h b/clang/include/clang/Basic/FileManager.h index b14ad83df25c..9017f4147d30 100644 --- a/clang/include/clang/Basic/FileManager.h +++ b/clang/include/clang/Basic/FileManager.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the FileManager interface. -// +/// +/// \file +/// \brief Defines the clang::FileManager interface and associated types. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_FILEMANAGER_H diff --git a/clang/include/clang/Basic/FileSystemOptions.h b/clang/include/clang/Basic/FileSystemOptions.h index 81e928da2a70..38f134631248 100644 --- a/clang/include/clang/Basic/FileSystemOptions.h +++ b/clang/include/clang/Basic/FileSystemOptions.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the FileSystemOptions interface. -// +/// +/// \file +/// \brief Defines the clang::FileSystemOptions interface. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_FILESYSTEMOPTIONS_H diff --git a/clang/include/clang/Basic/FileSystemStatCache.h b/clang/include/clang/Basic/FileSystemStatCache.h index 764ce92bcdfb..b39755b7c180 100644 --- a/clang/include/clang/Basic/FileSystemStatCache.h +++ b/clang/include/clang/Basic/FileSystemStatCache.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the FileSystemStatCache interface. -// +/// +/// \file +/// \brief Defines the FileSystemStatCache interface. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_FILESYSTEMSTATCACHE_H diff --git a/clang/include/clang/Basic/IdentifierTable.h b/clang/include/clang/Basic/IdentifierTable.h index 0b7e11f0de50..f668e6ec4d1a 100644 --- a/clang/include/clang/Basic/IdentifierTable.h +++ b/clang/include/clang/Basic/IdentifierTable.h @@ -6,10 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the IdentifierInfo, IdentifierTable, and Selector -// interfaces. -// +/// +/// \file +/// \brief Defines the clang::IdentifierInfo, clang::IdentifierTable, and +/// clang::Selector interfaces. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_IDENTIFIERTABLE_H diff --git a/clang/include/clang/Basic/LLVM.h b/clang/include/clang/Basic/LLVM.h index 813b49ed2353..13c5b445b8ee 100644 --- a/clang/include/clang/Basic/LLVM.h +++ b/clang/include/clang/Basic/LLVM.h @@ -7,9 +7,10 @@ // //===----------------------------------------------------------------------===// // -// This file forward declares and imports various common LLVM datatypes that -// clang wants to use unqualified. -// +/// \file +/// \brief Forward declares and imports various common LLVM datatypes that +/// clang wants to use unqualified. +/// //===----------------------------------------------------------------------===// #ifndef CLANG_BASIC_LLVM_H diff --git a/clang/include/clang/Basic/Lambda.h b/clang/include/clang/Basic/Lambda.h index df50d94894ae..0014ed26e1f3 100644 --- a/clang/include/clang/Basic/Lambda.h +++ b/clang/include/clang/Basic/Lambda.h @@ -6,9 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines several types used to describe C++ lambda -// expressions that are shared between the parser and AST. +/// +/// \file +/// \brief Defines several types used to describe C++ lambda expressions +/// that are shared between the parser and AST. +/// //===----------------------------------------------------------------------===// diff --git a/clang/include/clang/Basic/LangOptions.h b/clang/include/clang/Basic/LangOptions.h index 9c3b011f9ccb..2edb556afe5a 100644 --- a/clang/include/clang/Basic/LangOptions.h +++ b/clang/include/clang/Basic/LangOptions.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the LangOptions interface. -// +/// +/// \file +/// \brief Defines the clang::LangOptions interface. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_LANGOPTIONS_H diff --git a/clang/include/clang/Basic/Linkage.h b/clang/include/clang/Basic/Linkage.h index 6822b442e35e..7922813ff887 100644 --- a/clang/include/clang/Basic/Linkage.h +++ b/clang/include/clang/Basic/Linkage.h @@ -6,10 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the Linkage enumeration and various utility -// functions. -// +/// +/// \file +/// \brief Defines the Linkage enumeration and various utility functions. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_LINKAGE_H #define LLVM_CLANG_BASIC_LINKAGE_H diff --git a/clang/include/clang/Basic/MacroBuilder.h b/clang/include/clang/Basic/MacroBuilder.h index cb58376b468c..6df3a383df9d 100644 --- a/clang/include/clang/Basic/MacroBuilder.h +++ b/clang/include/clang/Basic/MacroBuilder.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the MacroBuilder utility class. -// +/// +/// \file +/// \brief Defines the clang::MacroBuilder utility class. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_MACROBUILDER_H diff --git a/clang/include/clang/Basic/Module.h b/clang/include/clang/Basic/Module.h index e6c2ba429d92..c8027f47028f 100644 --- a/clang/include/clang/Basic/Module.h +++ b/clang/include/clang/Basic/Module.h @@ -6,10 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the Module class, which describes a module in the source -// code. -// +/// +/// \file +/// \brief Defines the clang::Module class, which describes a module in the +/// source code. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_MODULE_H #define LLVM_CLANG_BASIC_MODULE_H @@ -137,7 +138,7 @@ public: llvm::SmallVector Exports; /// \brief Describes an exported module that has not yet been resolved - /// (perhaps because tASThe module it refers to has not yet been loaded). + /// (perhaps because the module it refers to has not yet been loaded). struct UnresolvedExportDecl { /// \brief The location of the 'export' keyword in the module map file. SourceLocation ExportLoc; diff --git a/clang/include/clang/Basic/ObjCRuntime.h b/clang/include/clang/Basic/ObjCRuntime.h index a1024c4a585e..13f13075fab2 100644 --- a/clang/include/clang/Basic/ObjCRuntime.h +++ b/clang/include/clang/Basic/ObjCRuntime.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines types useful for describing an Objective-C runtime. -// +/// +/// \file +/// \brief Defines types useful for describing an Objective-C runtime. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_OBJCRUNTIME_H diff --git a/clang/include/clang/Basic/OnDiskHashTable.h b/clang/include/clang/Basic/OnDiskHashTable.h index b92f1cf9c6ae..79273fcc798d 100644 --- a/clang/include/clang/Basic/OnDiskHashTable.h +++ b/clang/include/clang/Basic/OnDiskHashTable.h @@ -6,10 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines facilities for reading and writing on-disk hash -// tables. -// +/// +/// \file +/// \brief Defines facilities for reading and writing on-disk hash tables. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_ON_DISK_HASH_TABLE_H #define LLVM_CLANG_BASIC_ON_DISK_HASH_TABLE_H diff --git a/clang/include/clang/Basic/OpenCL.h b/clang/include/clang/Basic/OpenCL.h index 6f9785f25677..5904a3fc154b 100644 --- a/clang/include/clang/Basic/OpenCL.h +++ b/clang/include/clang/Basic/OpenCL.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines some OpenCL-specific enums. -// +/// +/// \file +/// \brief Defines some OpenCL-specific enums. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_OPENCL_H diff --git a/clang/include/clang/Basic/OperatorKinds.h b/clang/include/clang/Basic/OperatorKinds.h index 492a6bae041b..5900718644ac 100644 --- a/clang/include/clang/Basic/OperatorKinds.h +++ b/clang/include/clang/Basic/OperatorKinds.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines C++ overloaded operators. -// +/// +/// \file +/// \brief Defines an enumeration for C++ overloaded operators. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_OPERATOR_KINDS_H diff --git a/clang/include/clang/Basic/PartialDiagnostic.h b/clang/include/clang/Basic/PartialDiagnostic.h index 7dce172786bc..8e12a14a5124 100644 --- a/clang/include/clang/Basic/PartialDiagnostic.h +++ b/clang/include/clang/Basic/PartialDiagnostic.h @@ -6,10 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file implements a partial diagnostic that can be emitted anwyhere -// in a DiagnosticBuilder stream. -// +/// +/// \file +/// \brief Implements a partial diagnostic that can be emitted anwyhere +/// in a DiagnosticBuilder stream. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_PARTIALDIAGNOSTIC_H diff --git a/clang/include/clang/Basic/PrettyStackTrace.h b/clang/include/clang/Basic/PrettyStackTrace.h index 06a12644c36e..2f8cba42f965 100644 --- a/clang/include/clang/Basic/PrettyStackTrace.h +++ b/clang/include/clang/Basic/PrettyStackTrace.h @@ -6,11 +6,12 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the PrettyStackTraceEntry class, which is used to make -// crashes give more contextual information about what the program was doing -// when it crashed. -// +/// +/// \file +/// \brief Defines the PrettyStackTraceEntry class, which is used to make +/// crashes give more contextual information about what the program was doing +/// when it crashed. +/// //===----------------------------------------------------------------------===// #ifndef CLANG_BASIC_PRETTYSTACKTRACE_H diff --git a/clang/include/clang/Basic/SourceLocation.h b/clang/include/clang/Basic/SourceLocation.h index ce2ccde56e72..453827ca2dd1 100644 --- a/clang/include/clang/Basic/SourceLocation.h +++ b/clang/include/clang/Basic/SourceLocation.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the SourceLocation class. -// +/// +/// \file +/// \brief Defines the clang::SourceLocation class and associated facilities. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_SOURCELOCATION_H diff --git a/clang/include/clang/Basic/SourceManager.h b/clang/include/clang/Basic/SourceManager.h index c4eb0b5fa7ad..d5657c70e179 100644 --- a/clang/include/clang/Basic/SourceManager.h +++ b/clang/include/clang/Basic/SourceManager.h @@ -7,9 +7,10 @@ // //===----------------------------------------------------------------------===// /// -/// \file Defines the SourceManager interface. +/// \file +/// \brief Defines the SourceManager interface. /// -/// There are three different types of locations in a file\: a spelling +/// There are three different types of locations in a file: a spelling /// location, an expansion location, and a presumed location. /// /// Given an example of: @@ -19,7 +20,7 @@ /// /// and then later on a use of min: /// \code -/// \#line 17 +/// #line 17 /// return min(a, b); /// \endcode /// diff --git a/clang/include/clang/Basic/SourceManagerInternals.h b/clang/include/clang/Basic/SourceManagerInternals.h index 0ef0ee2de34b..012c63d1ce61 100644 --- a/clang/include/clang/Basic/SourceManagerInternals.h +++ b/clang/include/clang/Basic/SourceManagerInternals.h @@ -6,10 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the implementation details of the SourceManager -// class. -// +/// +/// \file +/// \brief Defines implementation details of the clang::SourceManager class. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_SOURCEMANAGER_INTERNALS_H diff --git a/clang/include/clang/Basic/Specifiers.h b/clang/include/clang/Basic/Specifiers.h index 4b08c4d155d1..ac81e56a8b29 100644 --- a/clang/include/clang/Basic/Specifiers.h +++ b/clang/include/clang/Basic/Specifiers.h @@ -6,10 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines various enumerations that describe declaration and -// type specifiers. -// +/// +/// \file +/// \brief Defines various enumerations that describe declaration and +/// type specifiers. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_SPECIFIERS_H diff --git a/clang/include/clang/Basic/TargetBuiltins.h b/clang/include/clang/Basic/TargetBuiltins.h index 9746dfebd742..ea7e2ccc28dc 100644 --- a/clang/include/clang/Basic/TargetBuiltins.h +++ b/clang/include/clang/Basic/TargetBuiltins.h @@ -6,6 +6,12 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// +/// +/// \file +/// \brief Enumerates target-specific builtins in their own namespaces within +/// namespace ::clang. +/// +//===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_TARGET_BUILTINS_H #define LLVM_CLANG_BASIC_TARGET_BUILTINS_H diff --git a/clang/include/clang/Basic/TargetInfo.h b/clang/include/clang/Basic/TargetInfo.h index 43075cd990ce..83060ba46391 100644 --- a/clang/include/clang/Basic/TargetInfo.h +++ b/clang/include/clang/Basic/TargetInfo.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the TargetInfo interface. -// +/// +/// \file +/// \brief Defines the clang::TargetInfo interface. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_TARGETINFO_H diff --git a/clang/include/clang/Basic/TargetOptions.h b/clang/include/clang/Basic/TargetOptions.h index f3c206f2cc96..19bfaff1f7c6 100644 --- a/clang/include/clang/Basic/TargetOptions.h +++ b/clang/include/clang/Basic/TargetOptions.h @@ -6,6 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// +/// +/// \file +/// \brief Defines the clang::TargetOptions class. +/// +//===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_FRONTEND_TARGETOPTIONS_H #define LLVM_CLANG_FRONTEND_TARGETOPTIONS_H diff --git a/clang/include/clang/Basic/TemplateKinds.h b/clang/include/clang/Basic/TemplateKinds.h index c6ea05bb1396..dda011a54e18 100644 --- a/clang/include/clang/Basic/TemplateKinds.h +++ b/clang/include/clang/Basic/TemplateKinds.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the TemplateNameKind enum. -// +/// +/// \file +/// \brief Defines the clang::TemplateNameKind enum. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_TEMPLATEKINDS_H #define LLVM_CLANG_TEMPLATEKINDS_H diff --git a/clang/include/clang/Basic/TokenKinds.h b/clang/include/clang/Basic/TokenKinds.h index 515390a8ce93..ff3b1419b2bc 100644 --- a/clang/include/clang/Basic/TokenKinds.h +++ b/clang/include/clang/Basic/TokenKinds.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the TokenKind enum and support functions. -// +/// +/// \file +/// \brief Defines the clang::TokenKind enum and support functions. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_TOKENKINDS_H diff --git a/clang/include/clang/Basic/TypeTraits.h b/clang/include/clang/Basic/TypeTraits.h index 721f44f40815..4089e1a88cb8 100644 --- a/clang/include/clang/Basic/TypeTraits.h +++ b/clang/include/clang/Basic/TypeTraits.h @@ -6,9 +6,10 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines enumerations for the type traits support. -// +/// +/// \file +/// \brief Defines enumerations for the type traits support. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_TYPETRAITS_H diff --git a/clang/include/clang/Basic/Version.h b/clang/include/clang/Basic/Version.h index f3f5b5a53a99..101eb7a1fb75 100644 --- a/clang/include/clang/Basic/Version.h +++ b/clang/include/clang/Basic/Version.h @@ -6,10 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This header defines version macros and version-related utility functions -// for Clang. -// +/// +/// \file +/// \brief Defines version macros and version-related utility functions +/// for Clang. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_VERSION_H diff --git a/clang/include/clang/Basic/VersionTuple.h b/clang/include/clang/Basic/VersionTuple.h index 814350d82d02..8a636d18a867 100644 --- a/clang/include/clang/Basic/VersionTuple.h +++ b/clang/include/clang/Basic/VersionTuple.h @@ -6,10 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This header defines the VersionTuple class, which represents a version in -// the form major[.minor[.subminor]]. -// +/// +/// \file +/// \brief Defines the clang::VersionTuple class, which represents a version in +/// the form major[.minor[.subminor]]. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_VERSIONTUPLE_H #define LLVM_CLANG_BASIC_VERSIONTUPLE_H diff --git a/clang/include/clang/Basic/Visibility.h b/clang/include/clang/Basic/Visibility.h index b9e21f27ee8b..6285cb4b7be6 100644 --- a/clang/include/clang/Basic/Visibility.h +++ b/clang/include/clang/Basic/Visibility.h @@ -6,10 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// -// -// This file defines the Visibility enumeration and various utility -// functions. -// +/// +/// \file +/// \brief Defines the clang::Visibility enumeration and various utility +/// functions. +/// //===----------------------------------------------------------------------===// #ifndef LLVM_CLANG_BASIC_VISIBILITY_H #define LLVM_CLANG_BASIC_VISIBILITY_H