docs/user/apidoc.dox

33 	or members of the API documentation team should read the third section
37 	\section formalrequirements Formal Requirements
39 	This section describes formal requirements, such as location and naming of
153 		you can read more about in the next section.
161 	consists of five slashes, a space, the title of the section, a space and
167 	\section commands Doxygen Commands
169 	This section describes all the Doxygen commands that will be used in the
176 	\note This section does not discuss which commands you should actually use
177 		in documentation. See the next section on \ref style for that. This
178 		section merely explains the different groupings and syntaxes of
201 		Tells Doxygen that the following section is going to be on the class as
218 		Tells Doxygen the section is going to be on the \c struct indicated by
224 		This block represents a page. See the section on \ref commands_pages for
231 	belongs to a certain section should be placed after a command that marks the
232 	start of that section. All the commands take a paragraph as answer. A
234 	section. Note that this list only shows the syntax of the commands. For the
235 	semantics, have a look at the next section on style. In member documentation
239 		This is the only \b mandatory section. Every member should have at least
242 		This section describes a parameter with the name \a parameter-name. The
246 		This section describes the return value. This is a totally free form
249 		This section describes the return value indicated by \a value.
251 		This section contains references to other parts of the documentation.
254 	documentation. See the style section to find out the appropriate situations
311 	sections. Use the \c \\section command to define a new section. It takes the
321 		keep the section markers clear.
341 	this section.
368 	long. See the \ref style section on how to effectively write group headers.
377 	you will end up using every now and then. This section will describe those
411 	argument, the name of the section, and it inserts a link with the name of
416 	\section style Writing Guidelines
418 	This final section will present guidelines for the actual writing of the
526 	extensive documentation. This section will go over the actual class
527 	description. This section will present a list of items you should think
565 	documented in a similar way. That's why this section deals with them
614 	This section helps you document (member) variables and defines that define
673 	members in that group. See the section \ref commands_grouping on how to
674 	define groups. This section is on what to put in the header block.