\test { paragraph describing a test case }
Starts a paragraph where a test case can be described. The description will also add the test case to a separate test list. The two instances of the description will be cross-referenced. Each test case in the test list will be preceded by a header that indicates the origin of the test case.
Here, creating a separate list is a very nice feature! I think one can use the test command to have a list of all the tricky points which will be useful for maintenance: simply ask newcomers to generate the Doxygen documentation, study the "Test List" and learn all the cases by heart.
* http://www.stack.nl/~dimitri/doxygen/commands.html#cmdtest
2 comments:
Why don't you use the \todo command which is probably designed for exactly that, and also makes a separate list?
I know the \todo command: however, I think it should be used for planned, but missing features. Here, my point is to generate a dedicated list of implemented "tricky" points for the sake of maintenance and newcomers.
Post a Comment