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

Consolidate declaration and definition documentation #11

Open
speedyleion opened this issue Dec 3, 2020 · 0 comments
Open

Consolidate declaration and definition documentation #11

speedyleion opened this issue Dec 3, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@speedyleion
Copy link
Owner

Conversation from #10 ,

One idea I've been trying to consider, is doing like doxygen and combining the documentation from the declaration and the definition. I think it would require an option to let the user specify if the docs go at the declaration or the definition location.

I think adding something like this would be incredibly useful, especially if also integrated with the viewsource extension, which would allow the developer to define the documentation in a header file, have it show up in the source (or header) and have it link to the source code.

The main idea is to consolidate any documentation in the declaration with that of the definition.
Some things to consider:

  • As @wynn-rj mentioned viewsource should probably default to linking to the definition.
  • If autocmodule is used where should the resultant documentation end up? Doxygen appears to only put it with the header (declaration). The header may be a good initial default.
@speedyleion speedyleion added the enhancement New feature or request label Dec 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant