Add support for @option tag (partially close #51) #64
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
- Revamp description and titles processing to normalize "\n" usage and remove empty lines at the start and end of description. - Add dt and dd rendering styles.
|
Hey, thank you for your contribution and your patience. I have no idea how I missed this great work. Thanks again for your time! |
landure
added a commit
to landure/shdoc
that referenced
this pull request
Aug 17, 2023
…st#64) * Add missing empty line in overview section output. * - Add @option for short option (-o) and long options (--option). - Revamp description and titles processing to normalize "\n" usage and remove empty lines at the start and end of description. - Add dt and dd rendering styles. * Add @option to README and example. * Remove useless description self-assignation. * Fix readme width after adding too long @option * Fix readme width by shorting @see example. * Fix missing < and > escaping in outputted markdown
landure
added a commit
to landure/shdoc
that referenced
this pull request
Aug 17, 2023
…st#64) * Add missing empty line in overview section output. * - Add @option for short option (-o) and long options (--option). - Revamp description and titles processing to normalize "\n" usage and remove empty lines at the start and end of description. - Add dt and dd rendering styles. * Add @option to README and example. * Remove useless description self-assignation. * Fix readme width after adding too long @option * Fix readme width by shorting @see example. * Fix missing < and > escaping in outputted markdown
landure
added a commit
to landure/shdoc
that referenced
this pull request
Aug 17, 2023
…st#64) * Add missing empty line in overview section output. * - Add @option for short option (-o) and long options (--option). - Revamp description and titles processing to normalize "\n" usage and remove empty lines at the start and end of description. - Add dt and dd rendering styles. * Add @option to README and example. * Remove useless description self-assignation. * Fix readme width after adding too long @option * Fix readme width by shorting @see example. * Fix missing < and > escaping in outputted markdown
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.
This PR add support for @option tag for short and long options.
<and>.$[0-9]or$@is processed as an @option tag, and a warning is displayed on stderr.It also revamp description and titles processing to limit the use of "\n" in code.