Add option to render function parameters immediately after the description #421
Conversation
This file contains 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
vermeeren
added
enhancement
|
Sorry for the wait and thanks for the patch, looks good to me. |
vermeeren
added a commit
that referenced
this pull request
Mar 14, 2019
albertosm27
added a commit
to Blosc/blosc-doc
that referenced
this pull request
Aug 12, 2019
See breathe-doc/breathe#421 This option makes the documentation generated by breathe put the parameters documentation before "remarks", "warnings", "return". Giving the more standard structure: function_signature: brief description params {return/remarks/warnings} -> in the order defined by the user.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
With this option the documentation generated from a function can have the "standard" structure:
function_signature:
brief
description
params
{return/remarks/warnings} -> in the order defined by the user.