Skip to content

[clang-doc] static member variables are not included #59813

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.

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

Closed
danakj opened this issue Jan 4, 2023 · 0 comments · Fixed by #135457
Closed

[clang-doc] static member variables are not included #59813

danakj opened this issue Jan 4, 2023 · 0 comments · Fixed by #135457

Comments

@danakj
Copy link
Contributor

danakj commented Jan 4, 2023

Some examples:

struct i16 final {
  static constexpr auto MIN_PRIMITIVE = __private::min_value<PrimitiveT>();
  static constexpr auto MAX_PRIMITIVE = __private::max_value<PrimitiveT>();
};

There's no reference to these members in the i16 docs.

Whereas hdoc at the moment doesn't generate any of the methods, but it does include the static member variables: https://docs.hdoc.io/danakj/subspace/r8A877CC61EAA03B1.html

# Member Variables
public int16_t primitive_value = {0}
public static const auto MIN_PRIMITIVE = <recovery-expr>(__private::min_value<short>)
public static const auto MAX_PRIMITIVE = <recovery-expr>(__private::max_value<short>)
public static const sus::num::i16 MIN
public static const sus::num::i16 MAX
public static const sus::num::u32 BITS

My command line in case it helps: ../llvm/build/install/bin/clang-doc --project-name=Subspace --format=html --output=docs --extra-arg=-Wno-error --repository=https://github.com/chromium/subspace/blob/main --public -p out compile_commands.json --executor=all-TUs

Here's an example in action: https://danakj.github.io/subspace-docs/sus/num/i32.html

ilovepi added a commit that referenced this issue Apr 11, 2025
clang-doc didn't visit VarDecl, and hence never collected info
from class statics members and functions.

Fixes #59813.
ilovepi added a commit that referenced this issue Apr 12, 2025
clang-doc didn't visit VarDecl, and hence never collected info
from class statics members and functions.

Fixes #59813.
kraj pushed a commit to kraj/llvm-project that referenced this issue Apr 12, 2025
Issue llvm#59813 mentions that static members are not included in
the documentation generated by clang-doc. This patch adds
some basic testing for that property, with the current incorrect
behavior. Follow up patches will address the missing documentation.
ilovepi added a commit that referenced this issue Apr 12, 2025
clang-doc didn't visit VarDecl, and hence never collected info
from class statics members and functions.

Fixes #59813.
ilovepi added a commit that referenced this issue Apr 12, 2025
Issue #59813 mentions that static members are not included in
the documentation generated by clang-doc. This patch adds
some basic testing for that property, with the current incorrect
behavior. Follow up patches will address the missing documentation.
ilovepi added a commit that referenced this issue Apr 12, 2025
clang-doc didn't visit VarDecl, and hence never collected info
from class statics members and functions.

Fixes #59813.
ilovepi added a commit that referenced this issue Apr 12, 2025
clang-doc didn't visit VarDecl, and hence never collected info
from class statics members and functions.

Fixes #59813.
var-const pushed a commit to ldionne/llvm-project that referenced this issue Apr 17, 2025
…35456)

Issue llvm#59813 mentions that static members are not included in
the documentation generated by clang-doc. This patch adds
some basic testing for that property, with the current incorrect
behavior. Follow up patches will address the missing documentation.
ilovepi added a commit that referenced this issue Apr 19, 2025
clang-doc didn't visit VarDecl, and hence never collected info
from class statics members and functions.

Fixes #59813.
IanWood1 pushed a commit to IanWood1/llvm-project that referenced this issue May 6, 2025
clang-doc didn't visit VarDecl, and hence never collected info
from class statics members and functions.

Fixes llvm#59813.
IanWood1 pushed a commit to IanWood1/llvm-project that referenced this issue May 6, 2025
clang-doc didn't visit VarDecl, and hence never collected info
from class statics members and functions.

Fixes llvm#59813.
IanWood1 pushed a commit to IanWood1/llvm-project that referenced this issue May 6, 2025
clang-doc didn't visit VarDecl, and hence never collected info
from class statics members and functions.

Fixes llvm#59813.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants