DDoc and @comments

Paul Findlay r.lph50+d at gmail.com
Sat Mar 1 21:01:21 PST 2008


>  I notice with DDoc that some new lines are missed  where @comments are
>  concerned
DDoc isn't an implementation of Javadocs.
So, you will find @see, @param etc. do not do anything special.
Instead there are different ways of doing it in DDoc.

http://www.digitalmars.com/d/1.0/ddoc.html has (some) details.

>  @param parent a widget which will be the parent of the new instance
>  (cannot be null) @param style the style of widget to construct
Try something like:
/**
 * Params:
 *      parent =  a widget which will be the parent of the new instance
 *                (cannot be null)
 *      style =   style the style of widget to construct
 */

>  @exception IllegalArgumentException
> ERROR_NULL_ARGUMENT - if the parent is null
/**
 * Throws: IllegalArgumentException if the parent is null
 */

>  @see Widget#getStyle
Not too sure, something like:
/**
 * See_Also:
 *    Widget.getStyle
 */
?

 - Paul



More information about the Digitalmars-d mailing list