Angband.oook.cz
Angband.oook.cz
AboutVariantsLadderForumCompetitionComicScreenshotsFunniesLinks

Go Back   Angband Forums > Angband > Development

Reply
 
Thread Tools Display Modes
Old January 21, 2020, 19:33   #1
eastwind
Apprentice
 
Join Date: Dec 2019
Location: Mexico, undisclosed location
Posts: 79
eastwind is on a distinguished road
/**< 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.
eastwind is offline   Reply With Quote
Old January 21, 2020, 20:19   #2
Nick
Vanilla maintainer
 
Nick's Avatar
 
Join Date: Apr 2007
Location: Canberra, Australia
Age: 54
Posts: 8,058
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
Old January 21, 2020, 22:19   #3
eastwind
Apprentice
 
Join Date: Dec 2019
Location: Mexico, undisclosed location
Posts: 79
eastwind is on a distinguished road
Thanks, something like that was one of my guesses.
eastwind is offline   Reply With Quote
Reply


Currently Active Users Viewing This Thread: 1 (0 members and 1 guests)
 
Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
Spell browser lost its header PowerWyrm Development 0 June 10, 2011 09:40
A plea for comments Derakon Development 4 May 30, 2011 17:20
A Few Comments about V Malatar Vanilla 20 January 5, 2010 22:40
3.1.0 Comments/Observations evariste Vanilla 6 January 17, 2009 02:25
3.10 Comments awldune Vanilla 3 January 11, 2009 14:29


All times are GMT +1. The time now is 11:35.


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