> PHPDoc always uses the first line *only* as short description, and > different bits end up on different places in the docs. > > See the documentation of __construct of ezcQuery. In the list it is > shows as just the first line: > > http://ezcomponents.org/docs/api/2007.2/Database/ezcQuery.html#sec-method-s >ummary > > In the description of the method, with both parts: > > http://ezcomponents.org/docs/api/2007.2/Database/ezcQuery.html#__construct > > This happens whether or no single new line is in between them. > > Because it makes it a bit more transparent what happens, *if* the new > line is there in the docblock, I would prefer that over no new-line. But > I don't think it's important enough to pro-actively change it.
I understand your point. I think the output of: http://ezcomponents.org/docs/api/2007.2/Database/ezcQuery.html#__construct should not have a newline after the first line. That is how I would have written the text 'by hand'. Maybe this discussion is just a matter of taste... Raymond. -- Components mailing list [email protected] http://lists.ez.no/mailman/listinfo/components
