[clang-doc] Track Descriptions and TypeDeclaration for types #138058
Merged
+9
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced May 1, 2025
|
@llvm/pr-subscribers-clang-tools-extra Author: Paul Kirth (ilovepi) ChangesSplit from #133161. This patch allows Typedefs to now track both their Co-authored-by: Peter Chou <[email protected]> Full diff: https://github.com/llvm/llvm-project/pull/138058.diff 1 Files Affected:
diff --git a/clang-tools-extra/clang-doc/Representation.h b/clang-tools-extra/clang-doc/Representation.h
index b0b34fc6f08dd..1d5c4dcaeaf37 100644
--- a/clang-tools-extra/clang-doc/Representation.h
+++ b/clang-tools-extra/clang-doc/Representation.h
@@ -415,7 +415,13 @@ struct TypedefInfo : public SymbolInfo {
TypeInfo Underlying;
- // Inidicates if this is a new C++ "using"-style typedef:
+ // Underlying type declaration
+ SmallString<16> TypeDeclaration;
+
+ /// Comment description for the typedef.
+ std::vector<CommentInfo> Description;
+
+ // Indicates if this is a new C++ "using"-style typedef:
// using MyVector = std::vector<int>
// False means it's a C-style typedef:
// typedef std::vector<int> MyVector;
@@ -458,7 +464,8 @@ struct EnumValueInfo {
// constant. This will be empty for implicit enumeration values.
SmallString<16> ValueExpr;
- std::vector<CommentInfo> Description; /// Comment description of this field.
+ /// Comment description of this field.
+ std::vector<CommentInfo> Description;
};
// TODO: Expand to allow for documenting templating.
|
|
note this whole stack lacks testing. I'll need to do that, or get help on that front, given that GSOC starts soon. |
ilovepi
force-pushed
the
users/ilovepi/clang-doc-improved-descriptions
branch
from
8e70c84 to
de5258a
Compare
petrhosek
approved these changes
May 7, 2025
Split from #133161. This patch allows Typedefs to now track both their declarations and full descriptions. Subsequent patches will leverage the additional fields in the representation. Co-authored-by: Peter Chou <[email protected]>
ilovepi
force-pushed
the
users/ilovepi/clang-doc-improved-descriptions
branch
from
de5258a to
fe5424d
Compare
GeorgeARM
pushed a commit
to GeorgeARM/llvm-project
that referenced
this pull request
May 7, 2025
…8058) Split from llvm#133161. This patch allows Typedefs to now track both their declarations and full descriptions. Subsequent patches will leverage the additional fields in the representation. Co-authored-by: Peter Chou <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Split from #133161. This patch allows Typedefs to now track both their
declarations and full descriptions. Subsequent patches will leverage the
additional fields in the representation.
Co-authored-by: Peter Chou [email protected]