codeblocks code completion doxygen comment

Codeblocks code completion doxygen comment how to#

that contain documentation connected with that tag are indented two spaces.

Lines containing comments (including docblocks) must wrap as close to 80 characters as possible without going over, with a few exceptions (noted in the Tag Reference below).

Docblocks must have * at the beginning of each line (see sample above).

All caps are used in comments only when referencing constants, for example TRUE.

To refer to a module or theme, use wording and capitalization like 'the Foo Bar module' (in other words, the module/theme name is a proper noun, not including the word 'module' or 'theme' in the proper noun).

Comments and variable names should be in English, and use US English spelling (e.g., 'color' not 'colour').

Sentences should be separated by single spaces.Document the current version of code, not differences from past code or future plans (except for and tags).Put a space between the comment character (the * or the //) and the first letter of the sentence.All documentation and comments should form proper sentences, use proper grammar and punctuation, and generally follow the same style guidelines as content:.This section contains standards related to all API docblocks. In the individual tag references, there are notes about Drupal standards that pertain to that particular tag. that it recognizes in documentation text into links to the documentation of those items.ĭrupal API documentation standards (general)

The API module automatically turns the names of functions, classes, etc.

There are also a few 'free-standing' docblocks (for documenting files and making topics - see tag reference for details).

To document a function, class, etc., the docblock must appear directly before the item being documented, with no blank line in between (see example above).

The first paragraph of a docblock is known as the summary.

Some tags also trigger paragraph breaks: The API module does not support blank lines within a single tag's documentation (for example, within a single parameter's documentation with The API module itself does not care about line length (Drupal documentation standards do, however, see below).

To make a paragraph break in a docblock, leave a blank line (see example above).

Docblocks normally have * at the beginning of each line, and the API module strips these out when formatting the documentation (see example above).

In-code comment lines starting with // and comment blocks starting with /* are not recognized as docblocks.

These are known in this document as docblocks.

The special documentation tags described in this document are only recognized within special PHP comment blocks that start with /**.

PHP files with syntax errors could cause problems.

When parsing a PHP file, the API module parses both documentation and PHP code.

The API module treats files with the following extensions as PHP.

General notes on the API module and the documentation it will parse: (code being documented goes here, such as a function declaration, class, etc.)

The API module parses documentation that is in special documentation blocks (known as 'docblocks' in the rest of this document). It was originally based on Doxygen, but it has evolved into something that has its own set of tags and a lot of Drupal-specific functionality. The API module parses documentation and code in PHP files, and it expects documentation to be in a format similar to other code/documentation parsing systems such as PHPDoc, JavaDoc, etc. Notes and standards General considerations for API module parsing A reference to the tags used in this documentation.The purpose of the Drupal project's standards for API documentation and comments in PHP code is to ensure that the API module can parse/display the documentation, programmers looking at the PHP files can read/understand the documentation, and integrated developer environments (IDEs) can work successfully with the code and documentation.

Codeblocks code completion doxygen comment how to#

How to write documentation for PHP code so that the API module can successfully parse it and display it on (and other similar sites).Note: Changes to Drupal coding standards are proposed and discussed in issues in the Coding Standards project.