theseer / phpdox

Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT)
http://phpdox.de
Other
599 stars 121 forks source link

Multiline annotation for class constants fails to add subsequent lines #320

Closed davidsneighbour closed 6 years ago

davidsneighbour commented 6 years ago

I have constants in classes documented as the following sample:

/**
 * @constant Invoice is solved - meaning invoice is paid and all related bookings are set to solved
 */
const STATUS_SOLVED = 900;

This parses correct. But when I cut the string in two lines (so it's below 80 characters per line) the second and subsequent lines are ignored in the resulting documentation file.

/**
 * @constant Invoice is solved - meaning invoice is paid and all related 
 *            bookings are set to solved
 */
const STATUS_SOLVED = 900;

Are there any rules that constants have to be documented in one single line?

theseer commented 6 years ago

No, that seems to be a bug in the docblock parsing.

davidsneighbour commented 6 years ago

Just to go sure: with subsequent lines I only mean the multi-line docs for this one constant, not the following constants or parameters documentation.

theseer commented 6 years ago

Two side notes regarding the fix for future reference: