Parsable markup documentation with doxygen #491
Merged
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
bebehei
force-pushed
the
docs
branch
3 times, most recently
from
abaf676
to
1abad34
Compare
|
Enforcing the documentation comments with YCM can get very profitable. See the GetDocs command. |
tsipinakis
requested changes
Feb 22, 2018
HACKING.md
Outdated
| - Use `@param` to describe all input parameters | ||
| - Documentation comments should start with a double star (`/**`) | ||
| - Look forward to properly link all member types | ||
| - Functions with an appended `()` |
There was a problem hiding this comment.
These 2 lines needs some more explanation, I can't make much sense of them.
There was a problem hiding this comment.
I've added an example and also the way to reference symbols/variables.
HACKING.md
Outdated
| - Add comments to all functions and methods | ||
| - Markdown inside the comments is allowed and also desired | ||
| - Add the comments to the prototype. Doxygen will merge the protoype and implementation documentation anyways. | ||
| Except for **static** methods. Add the documentation header to the implementation and *not to the prototype*. |
There was a problem hiding this comment.
That period is going to confuse people comma would be more appropriate here.
bebehei
force-pushed
the
docs
branch
2 times, most recently
from
b9db3de
to
d7d94dc
Compare
tsipinakis
approved these changes
Feb 22, 2018
karlicoss
pushed a commit
to karlicoss/dunst
that referenced
this pull request
Mar 21, 2019
Parsable markup documentation with doxygen
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 is a start to have the documentation with doxygen, which also contains markup to be able to compile it at the end of the day.
With this, one's able to compile a document to get an overview of the internal structures of dunst.
I've moved my own comments of the
queues.candlog.cfiles to be compliant.