Hi Ray!

On 01/04/2008 01:38 PM Raymond Bosman wrote:
>> I remember that we decided not to repeat the information of the short
>> desc in the long version. But I can't see what it has to do with the
>> newline?

> The newline won't be correct if the first and second sentence belong in the 
> same paragraph. 
> 
> You may be right that we never decided about the newline, though. 

> Is the newline justified in the next example?
> 
> /**
>  * Generates a unique hash from the current options.
>  * For example the default values return: 
>  * <code>
>  * 1.  "updqr0"
>  * </code>
>  */

Sure, why not? phpDocumentor renders the first line as a headline and
the following part as floating text. What is wrong in deviding those two
parts in the docs themselves, too?


Regards,
Toby
-- 
Mit freundlichen Grüßen / Med vennlig hilsen / With kind regards

Tobias Schlitt (GPG: 0xC462BC14) eZ Components Developer

[EMAIL PROTECTED] | eZ Systems AS | ez.no
-- 
Components mailing list
[email protected]
http://lists.ez.no/mailman/listinfo/components

Reply via email to