Skip to content
Snippets Groups Projects
Commit bcfc0e65 authored by Steven Wittens's avatar Steven Wittens
Browse files

Fix formatting of doxygen for drupal_parse_info_file() (for api.drupal.org).

parent 552e2cbc
No related branches found
No related tags found
2 merge requests!7452Issue #1797438. HTML5 validation is preventing form submit and not fully...,!789Issue #3210310: Adjust Database API to remove deprecated Drupal 9 code in Drupal 10
...@@ -2489,6 +2489,8 @@ function drupal_common_themes() { ...@@ -2489,6 +2489,8 @@ function drupal_common_themes() {
* Files should use an ini-like format to specify values. * Files should use an ini-like format to specify values.
* White-space generally doesn't matter, except inside values. * White-space generally doesn't matter, except inside values.
* e.g. * e.g.
*
* @verbatim
* key = value * key = value
* key = "value" * key = "value"
* key = 'value' * key = 'value'
...@@ -2498,15 +2500,21 @@ function drupal_common_themes() { ...@@ -2498,15 +2500,21 @@ function drupal_common_themes() {
* key = 'multi-line * key = 'multi-line
* *
* value' * value'
* key
* =
* 'value'
* @endverbatim
* *
* Arrays are created using a GET-like syntax: * Arrays are created using a GET-like syntax:
* *
* @verbatim
* key[] = "numeric array" * key[] = "numeric array"
* key[index] = "associative array" * key[index] = "associative array"
* key[index][] = "nested numeric array" * key[index][] = "nested numeric array"
* key[index][index] = "nested associative 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. * Comments should start with a semi-colon at the beginning of a line.
* *
...@@ -2514,19 +2522,20 @@ function drupal_common_themes() { ...@@ -2514,19 +2522,20 @@ function drupal_common_themes() {
* variable_get() and variable_set() for that. * variable_get() and variable_set() for that.
* *
* Information stored in the module.info file: * Information stored in the module.info file:
* name - The real name of the module for display purposes. * - name: The real name of the module for display purposes.
* description - A brief description of the module. * - description: A brief description of the module.
* dependencies - An array of short names (shortname) of other modules this * - dependencies: An array of shortnames of other modules this module depends on.
* module depends on. * - package: The name of the package of modules this module belongs to.
* package - The name of the package of modules this module belongs to.
* *
* Example of .info file: * Example of .info file:
* @verbatim
* name = Forum * name = Forum
* description = Enables threaded discussions about general topics. * description = Enables threaded discussions about general topics.
* dependencies[] = taxonomy * dependencies[] = taxonomy
* dependencies[] = comment * dependencies[] = comment
* package = Core - optional * package = Core - optional
* version = VERSION * version = VERSION
* @endverbatim
* *
* @param $filename * @param $filename
* The file we are parsing. Accepts file with relative or absolute path. * The file we are parsing. Accepts file with relative or absolute path.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment