Angband Forums

Angband Forums (http://angband.oook.cz/forum/index.php)
-   Development (http://angband.oook.cz/forum/forumdisplay.php?f=10)
-   -   /**< comments in header files */ (http://angband.oook.cz/forum/showthread.php?t=9788)

eastwind January 21, 2020 19:33

/**< comments in header files */
 
A number of header files comment struct fields with /**< comments.

What does this denote? I could guess but I won't as I can think of several possibilities.

There's nothing about it in the coding guidelines I found by searching, and searching on angband **< didn't turn up anything.

Nick January 21, 2020 20:19

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.

eastwind January 21, 2020 22:19

Thanks, something like that was one of my guesses.


All times are GMT +1. The time now is 05:41.

Powered by vBulletin® Version 3.8.11
Copyright ©2000 - 2020, vBulletin Solutions Inc.