some_function |
Defined in
<comments.cpp> |
|
A function that does a thing, and does it well.
This is a longer description of this function that does things as well as it does. Notice how long this comment is! So impressive. 💥
Preconditions
An example precondition.
Parameters
| in |
|
|
an input parameter |
| inout |
|
|
a bidirectional parameter |
| out |
|
|
an output parameter |
Returns
Some additional value.
Postconditions
An example postcondition.
Exceptions
std::runtime_error if the function actually can’t do the thing. Sorry!
To Do
This really could use some cleanup. Although, its implementation doesn’t exist…
Warning
This function may be very expensive to run. Do not call it inside a loop.