Skip to content
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

Automatic group detection is incomplete #24

Open
fsaintjacques opened this issue May 9, 2016 · 3 comments
Open

Automatic group detection is incomplete #24

fsaintjacques opened this issue May 9, 2016 · 3 comments

Comments

@fsaintjacques
Copy link

See the libtwiddle documentation, there should be 2 distinct group called bitmap and bitmap_rle, yet they get merged into bitmap. I believe the following code makes a bold assumption where the first word splited by _ is the group name.

Would there be a way to specify the group which a function lives in? For example, in libgit2, we can see the following header in most files.

Some suggestions

  • Use a special comment in each function, say @group
  • Have the user provide a list of groups in the config file and bind a function to the longest prefix matching group in the list
@niess
Copy link
Contributor

niess commented May 10, 2016

I got the same problem. I changed the naming of my functions which with rather OK in my case. The second suggestion, i.e. provide exceptions for group names in the config file, should be rather straightforward to implement, changing only docurium.rb hopefully?

@fsaintjacques
Copy link
Author

I would see the provided group list as the norm, and then resorting to the split trick if it doesn't match anything. This wouldn't break libgit2 current behaviour if the don't provide groups in the JSON configuration.

@carlosmn
Copy link
Member

Those whole-file comments in libgit2 are left-over from doxygen. docurium currently uses the clang parser, which means those aren't recorded anywhere (and the same goes for macros, unfortunately).

Having the group explicitly in the docs would be a way to solve this. We likely won't use this in libgit2 though since we have the same general policy of using underscores to namespace. So there is no incentive for me to write this feature.

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

No branches or pull requests

3 participants