-
Notifications
You must be signed in to change notification settings - Fork 0
cvs tags, and catalyst's version, and api.mahara.org
Br3nda/drupal-module-api
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
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,v 1.5 2006/03/06 16:33:13 JonBob Exp $ 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.
About
cvs tags, and catalyst's version, and api.mahara.org
Resources
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published