summaryrefslogtreecommitdiff
path: root/includes
diff options
context:
space:
mode:
authorSteven Wittens <steven@10.no-reply.drupal.org>2007-04-18 02:49:33 +0000
committerSteven Wittens <steven@10.no-reply.drupal.org>2007-04-18 02:49:33 +0000
commitbcfc0e651cf59937df63caa42410556cb37dff31 (patch)
tree1a8dc51150a2cb791ca2cc2f757d3ef90f1a6fa1 /includes
parent552e2cbc0970ca27c13717ce6a6e1bb338d3b25a (diff)
downloadbrdo-bcfc0e651cf59937df63caa42410556cb37dff31.tar.gz
brdo-bcfc0e651cf59937df63caa42410556cb37dff31.tar.bz2
Fix formatting of doxygen for drupal_parse_info_file() (for api.drupal.org).
Diffstat (limited to 'includes')
-rw-r--r--includes/common.inc43
1 files changed, 26 insertions, 17 deletions
diff --git a/includes/common.inc b/includes/common.inc
index f9c401f39..3aa5f0282 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -2489,24 +2489,32 @@ function drupal_common_themes() {
* Files should use an ini-like format to specify values.
* White-space generally doesn't matter, except inside values.
* e.g.
- * key = value
- * key = "value"
- * key = 'value'
- * key = "multi-line
*
- * value"
- * key = 'multi-line
+ * @verbatim
+ * key = value
+ * key = "value"
+ * key = 'value'
+ * key = "multi-line
*
- * value'
+ * value"
+ * key = 'multi-line
+ *
+ * value'
+ * key
+ * =
+ * 'value'
+ * @endverbatim
*
* Arrays are created using a GET-like syntax:
*
- * key[] = "numeric array"
- * key[index] = "associative array"
- * key[index][] = "nested numeric array"
- * key[index][index] = "nested associative array"
+ * @verbatim
+ * key[] = "numeric array"
+ * key[index] = "associative array"
+ * key[index][] = "nested numeric array"
+ * key[index][index] = "nested associative array"
+ * @endverbatim
*
- * PHP constants are substituted in, but only when used as the entire value.
+ * PHP constants are substituted in, but only when used as the entire value:
*
* Comments should start with a semi-colon at the beginning of a line.
*
@@ -2514,19 +2522,20 @@ function drupal_common_themes() {
* variable_get() and variable_set() for that.
*
* Information stored in the module.info file:
- * name - The real name of the module for display purposes.
- * description - A brief description of the module.
- * dependencies - An array of short names (shortname) of other modules this
- * module depends on.
- * package - The name of the package of modules this module belongs to.
+ * - name: The real name of the module for display purposes.
+ * - description: A brief description of the module.
+ * - dependencies: An array of shortnames of other modules this module depends on.
+ * - package: The name of the package of modules this module belongs to.
*
* Example of .info file:
+ * @verbatim
* name = Forum
* description = Enables threaded discussions about general topics.
* dependencies[] = taxonomy
* dependencies[] = comment
* package = Core - optional
* version = VERSION
+ * @endverbatim
*
* @param $filename
* The file we are parsing. Accepts file with relative or absolute path.