Documentation formatting fixes #2396
Conversation
| GIT_IDXENTRY_EXTENDED = (0x4000), | ||
| GIT_IDXENTRY_VALID = (0x8000), | ||
| GIT_IDXENTRY_STAGESHIFT = 12 | ||
| } git_idxentry_flags; |
There was a problem hiding this comment.
To me, these masks are a very strange thing to put into an enum. I would almost rather change the docs than do this, because I think defining them in this way is more likely to cause confusion for most C users...
There was a problem hiding this comment.
Yeah... the thing is that defines aren't actually part of the AST, so clang won't attach any comments to them, which means we won't show them in docurium. This is a way of working around it.
I'm not sure how to work around this other than going back to regex for defines, which I guess wouldn't be the worst thing.
We should probably check to see if these flags is what we should be using externally, since IIRC we provide methods to grab the data out either way.
There was a problem hiding this comment.
After looking more closely, we can extract VALID and EXTENDED into their own flags enum, and the rest go into an extended flags enum, which do represent how we do things elsewhere.
|
Apart from that comment about the masks, ✨ from me! |
These are some issues I found while playing around with the new parser for docurium.
The documentation has shown this as a single enum for a long time. These should in fact be two enums. One with the bits for the flags and another with the bits for the extended flags.
|
Looks good with the split. |
Documentation formatting fixes
Stuff I found while trying to get the clang version of docurium to display docs better.
I'm not sure if the idxentry changes will affect much, since we should be accepting ints anyway.