4. Glossary

DocBlock

This is a DocComment containing a single PHPDoc and represents the basic in-source representation.

Example:

 /**
  * Returns the name of this object.
  *
  * @return string
  */

Intermediate Structure File

phpDocumentor generates an intermediate XML file between parsing your source code and generating the HTML output. This structure file (called structure.xml) contains the raw analyzed data of your project.

This same file is also used by phpDocumentor to do incremental parsing of your project by comparing the contents of this file with the content on disk.

It is thus recommended to keep your structure file and allow phpDocumentor to re-use the contained information.

PHPDoc

This is a section of documentation which provides information on several aspects of Structural Elements.

A PHPDoc is usually enveloped in a DocComment.

Example:

  Returns the name of this object.

  @return string

Example enveloped in a DocComment:

 /**
  * Returns the name of this object.
  *
  * @return string
  */

DocComment

This is a special type of comment which starts with /**, ends with */ and may contain any number of lines in between. Every line should start with an asterisk, which is aligned with the first asterisk of the opening clause.

Single line example:

 /** <...> */

Multiline example:

 /**
  * <...>
  */

Structural Elements

This is a collection of Programming Constructs which SHOULD be preceded by a DocBlock. The collection contains the following constructs:

• namespace
• require(_once)
• include(_once)
• class
• interface
• trait
• function (including methods)
• property
• constant
• variables, both local and global scope.

It is RECOMMENDED to precede Structural Elements with a DocBlock at its definition and not with each individual usage.

Example:

 /** @type int This is a counter. */
 $int = 0;

 // there should be no docblock here
 $int++;

Or:

 /**
  * This class acts as an example on where to position a DocBlock.
  */
 class Foo
 {
     /** @type string|null Should contain a description if available */
     protected $description = null;

     /**
      * This method sets a description.
      *
      * @param string $description A text with a maximum of 80 characters.
      *
      * @return void
      */
     public function setDescription($description)
     {
         // there should be no docblock here
         $this->description = $description;
     }
 }

Another example is to document the variable in a foreach explicitly; many IDEs use this information to help you with auto-completion:

 /** @type \Sqlite3 $sqlite */
 foreach($connections as $sqlite) {
     // there should be no docblock here
     $sqlite->open('/my/database/path');
     <...>
 }

Type

This is a generic name for anything that can be returned or provided as identity for a value.

It is recommended to read the chapter Definition of a ‘Type’ for a detailed description.