The KDOC Handbook: Write developer documentation, easily and quickly | ||
---|---|---|
Prev | Appendix A. Doc tag reference | Next |
A list item.
Mark member as internal to the library and not for external use.
Marks member as obsolete.
Provide version information about the member. I normally set this to the RCS/CVS ID tag.
Specify the author.
Specify the version of the API in which this member was added.
A section heading, for grouping your doc comment logically.
A block of literal (preformatted) text, useful for code examples.
Embed an image in the output. This can be set to a URL, but it is better to use a path if possible since this will allow the image to be included in other formats in the future.
Links to related information.
Like @see, but inline, so it can be used within a text paragraph. Also, only one member can be referenced at a time, so you will have to include multiple @ref tags for multiple members.