Skip to content

[clang-doc] Track Descriptions and TypeDeclaration for types #138058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2025
Merged

[clang-doc] Track Descriptions and TypeDeclaration for types #138058

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions clang-tools-extra/clang-doc/Representation.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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.
Expand Down
Loading