/**< comments in header files */

Collapse
X
 
  • Time
  • Show
Clear All
new posts
  • eastwind
    Apprentice
    • Dec 2019
    • 79

    /**< 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
    Vanilla maintainer
    • Apr 2007
    • 9647

    #2
    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.

    Comment

    • eastwind
      Apprentice
      • Dec 2019
      • 79

      #3
      Thanks, something like that was one of my guesses.

      Comment

      Working...
      😀
      😂
      🥰
      😘
      🤢
      😎
      😞
      😡
      👍
      👎