This repository was archived by the owner on Nov 15, 2023. It is now read-only.
improve modules doc generation by support macros #1975
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gui1117
added
A0-please_review
bkchr
reviewed
Mar 14, 2019
bkchr
approved these changes
Mar 14, 2019
Member
|
Please merge master. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
related to #1917
It is not fully defined definitive doc but at least it makes a start for future improvment which will rely on modifying doc only.
Also I'm still mixed about something: Documentation passed in decl_module appears for Call enum which makes sense, but then Module structure has no documentation. it may needs none, I don't know what to write on it.
Now except Module struct all type of a module can be documented with macro or have default documentation.