[clang] [llvm] [clang] Add/enhance documentation for some important classes. (PR #109795)

via llvm-commits llvm-commits at lists.llvm.org
Tue Sep 24 06:07:34 PDT 2024


github-actions[bot] wrote:

<!--LLVM CODE FORMAT COMMENT: {clang-format}-->


:warning: C/C++ code formatter, clang-format found issues in your code. :warning:

<details>
<summary>
You can test this locally with the following command:
</summary>

``````````bash
git-clang-format --diff cce1fa39eabfca4907ff8d616618683eec1a5486 8dd7d0afc65526f152a02cbd5772ba9882cc2614 --extensions h -- clang/include/clang/AST/DeclBase.h clang/include/clang/AST/Stmt.h clang/include/clang/AST/Type.h clang/include/clang/AST/TypeLoc.h clang/include/clang/Basic/SourceManager.h llvm/include/llvm/Support/FileSystem/UniqueID.h llvm/include/llvm/Support/VirtualFileSystem.h
``````````

</details>

<details>
<summary>
View the diff from clang-format here.
</summary>

``````````diff
diff --git a/clang/include/clang/AST/Type.h b/clang/include/clang/AST/Type.h
index 4af66bf571..fc7aeaf928 100644
--- a/clang/include/clang/AST/Type.h
+++ b/clang/include/clang/AST/Type.h
@@ -1827,7 +1827,7 @@ enum class VectorKind;
 ///
 /// All types are allocated within the ASTContext, interned, and immutable.
 /// For compactness, qualifiers (`const int`) do not create distinct Types.
-/// See QualType - essentially a Type* with cv-qualifiers stored in low bits. 
+/// See QualType - essentially a Type* with cv-qualifiers stored in low bits.
 class alignas(TypeAlignment) Type : public ExtQualsTypeCommonBase {
 public:
   enum TypeClass {
diff --git a/clang/include/clang/AST/TypeLoc.h b/clang/include/clang/AST/TypeLoc.h
index 67e636aa40..648285b253 100644
--- a/clang/include/clang/AST/TypeLoc.h
+++ b/clang/include/clang/AST/TypeLoc.h
@@ -103,7 +103,7 @@ class UnresolvedUsingTypenameDecl;
 ///
 /// There is a lot of redundancy here: the PointerTypeLoc structure mirrors
 /// the corresponding PointerType, and we're just adding some SourceLocations.
-/// 
+///
 /// Instead, this more compact representation is used:
 ///
 ///   PointerTypeLoc(
diff --git a/clang/include/clang/Basic/SourceManager.h b/clang/include/clang/Basic/SourceManager.h
index a1c7733da4..4d58571a49 100644
--- a/clang/include/clang/Basic/SourceManager.h
+++ b/clang/include/clang/Basic/SourceManager.h
@@ -655,7 +655,7 @@ using ModuleBuildStack = ArrayRef<std::pair<std::string, FullSourceLoc>>;
 ///   - code after preprocessing e.g. expanded from an `assert()` macro
 ///   - the relationship between the two, e.g. where the `assert()` was written
 ///
-/// SourceManager is designed to represent this information compactly. 
+/// SourceManager is designed to represent this information compactly.
 /// AST nodes hold SourceLocations pointing at tokens that were parsed,
 /// so that diagnostics can point to relevant source code (including macros).
 /// A SourceLocation is a 32-bit integer, and is only meaningful together with
@@ -665,7 +665,7 @@ using ModuleBuildStack = ArrayRef<std::pair<std::string, FullSourceLoc>>;
 /// exposes them as FileEntrys.
 /// SourceManager does not generally know about tokens or AST nodes, the lexer
 /// and parser are layered above SourceManager.
-/// 
+///
 /// ====== SourceLocations, FileIDs, and SLocEntrys =======
 ///
 /// A SourceLocation can point at any byte of code. Rather than store

``````````

</details>


https://github.com/llvm/llvm-project/pull/109795


More information about the llvm-commits mailing list