View Single Post
Old January 21, 2020, 20:19   #2
Nick
Vanilla maintainer
 
Nick's Avatar
 
Join Date: Apr 2007
Location: Canberra, Australia
Age: 54
Posts: 8,256
Donated: $60
Nick will become famous soon enough
It's for building source documentation with doxygen. Here is the current source documentation for the latest build.

As an example, in the documenation for player.h, compare the descriptions of struct quest and struct player_race.

The comment headers above functions that look like this:
Code:
/**
 * Chooses a room template of a particular kind at random.
 * \param typ template room type - currently unused
 * \return a pointer to the room template
 */
are another example of doxygen instructions; this one gives this doxygen output.

Note that this is far from completely done throughout the codebase.
__________________
One for the Dark Lord on his dark throne
In the Land of Mordor where the Shadows lie.
Nick is offline   Reply With Quote