Skip to content

Instantly share code, notes, and snippets.

@NumEricR

NumEricR/PHPDoc_Constants.php

Created May 7, 2013 12:31
Show Gist options
  • Save NumEricR/5532215 to your computer and use it in GitHub Desktop.
Save NumEricR/5532215 to your computer and use it in GitHub Desktop.
Download ZIP
Possible constants doc issue with PHPDocumentor 2.
Raw
PHPDoc_Constants.php
/*
$ pear upgrade phpdoc/phpDocumentor-alpha
Nothing to upgrade
*/
/*
$ phpdoc --version
phpDocumentor version 2.0.0a12
*/
/**
* Description 1.
*/
define('CONSTANT1', 'constant_1');
/**
* @const CONSTANT2 Description 2
*/
define('CONSTANT2', 'constant_2');
/**
* @constant CONSTANT3 Description 3
*/
define('CONSTANT3', 'constant_3');
@mvriel
Copy link

mvriel commented May 7, 2013 

/**
 * Description 1.
 */
define('CONSTANT1', 'constant_1');

/**
 * @var string Description 2.
 */
define('CONSTANT2', 'constant_2');

These are the two supported notations; @constant and @const do not exist.
The first is the same as your first entry; it should be supported.

@NumEricR
Copy link
Author

NumEricR commented May 7, 2013

My related issue: "Constants documentation not used"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment