Inline Parameter Documentation#
This is currently flawed as it doesn’t know where to sensibly put the parameters in the final description.
It currently defaults to the top of the detail description block which means it comes between the brief description text and the detailed description text which is less than ideal, but attempts to programmatically figure out where the detail description text ends have failed. Something for future work.
Example#
-
class InlineTest#
- #include <inline.h>
A class to demonstrate inline documentation syntax.
Public Functions
-
const char *member(char c, int n)#
A member function.
Details about member function
- Parameters:
c – c a character.
n – n an integer.
- Throws:
std::out_of_range – parameter is out of range.
- Returns:
a character pointer.
-
const char *member(char c, int n)#
- file inline.h
- #include <stdexcept>