modules/api/README.txt

This is an implementation of a subset of the Doxygen documentation generator
specification, tuned to produce output that best benefits the Drupal code base.
It is designed to assume the code it documents follows Drupal coding conventions,
and supports the following Doxygen constructs:
  @mainpage
  @file
  @defgroup
  @ingroup
  @addtogroup (as a synonym of @ ingroup)
  @param
  @return
  @link
  @see
  @{
  @}


In addition to Doxygen syntax requirements, the following restrictions are made
on the code format. These are all Drupal coding conventions.

All documentation blocks must use the syntax:

/**
 * Documentation here.
 */

The leading spaces are required.

When documenting a function, the documentation block must immediately precede the
function it documents, with no intervening blank lines.

There may be no intervening spaces between a function name and the left parenthesis
that follows it.

Functions must be closed by a right curly bracket in the first column. No lines
inside a function may have a right curly bracket in the first column.


Besides the Doxygen features that are supported, this module also provides the
following features:

CVS version numbers and dates are parsed from $Id: README.txt 2972 2006-03-06 16:16:12Z jchaffer $ tags and reported.

Functions may be in multiple groups (Doxygen ignores all but the first group). This
allows, for example, theme_menu_tree() to be marked as both "themeable" and part of
the "menu system".

Function calls to PHP library functions are linked to the PHP manual.

Function calls have tooltips briefly describing the called function.

Documentation pages have non-volatile, predictable URLs, so links to individual
functions will not be invalidated when the number of functions in a document changes.
1	This is an implementation of a subset of the Doxygen documentation generator
2	specification, tuned to produce output that best benefits the Drupal code base.
3	It is designed to assume the code it documents follows Drupal coding conventions,
4	and supports the following Doxygen constructs:
5	@mainpage
6	@file
7	@defgroup
8	@ingroup
9	@addtogroup (as a synonym of @ ingroup)
10	@param
11	@return
12	@link
13	@see
14	@{
15	@}
16
17
18	In addition to Doxygen syntax requirements, the following restrictions are made
19	on the code format. These are all Drupal coding conventions.
20
21	All documentation blocks must use the syntax:
22
23	/**
24	* Documentation here.
25	*/
26
27	The leading spaces are required.
28
29	When documenting a function, the documentation block must immediately precede the
30	function it documents, with no intervening blank lines.
31
32	There may be no intervening spaces between a function name and the left parenthesis
33	that follows it.
34
35	Functions must be closed by a right curly bracket in the first column. No lines
36	inside a function may have a right curly bracket in the first column.
37
38
39	Besides the Doxygen features that are supported, this module also provides the
40	following features:
41
42	CVS version numbers and dates are parsed from $Id: README.txt 2972 2006-03-06 16:16:12Z jchaffer $ tags and reported.
43
44	Functions may be in multiple groups (Doxygen ignores all but the first group). This
45	allows, for example, theme_menu_tree() to be marked as both "themeable" and part of
46	the "menu system".
47
48	Function calls to PHP library functions are linked to the PHP manual.
49
50	Function calls have tooltips briefly describing the called function.
51
52	Documentation pages have non-volatile, predictable URLs, so links to individual
53	functions will not be invalidated when the number of functions in a document changes.