Add manual pages #186
Open
Add manual pages #186
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
As hated as they are, manpages are still quite commonly used by \*nix programmers writing code. Given how semantic mdoc can be, it's not *that* painful to write and consume nowadays. I am not saying we should not add doxygen comments to the headers.
ulfjack
reviewed
Oct 15, 2020
| @@ -0,0 +1,91 @@ | |||
| .\" Please update the date every time you change the doc! | |||
There was a problem hiding this comment.
Did you write these by hand or is there a way to auto-generate them from the header files?
There was a problem hiding this comment.
Wrote it by hand, but the prototypes are definitely being auto-generated somewhere in the world...
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.
As hated as they are, manpages are still quite commonly used by *nix
programmers writing code. Given how semantic mdoc can be, it's not
that painful to write and consume nowadays.
I am not saying we should not add doxygen comments to the headers.