[Laszlo-dev] Doc comment caution

P T Withington ptw at pobox.com
Tue May 13 06:15:34 PDT 2008


I cleverly thought that I could have a single comment at the top of my  
file:

> /**
>  * @copyright Copyright 2001-2008 Laszlo Systems, Inc.  All Rights  
> Reserved.
>  *            Use is subject to license terms.
>  *
>  * @affects lztimer
>  * @topic LFC
>  * @subtopic Services
>  * @access public
>  *
>  * <p>LzTimer is used to invoke functionality after a specific
> ...

But that causes the doc tool to ignore my long comment as  
documentation for the class.  Only the @shortdesc showed up.

You apparently need to break the comment up:

> /**
>  * @copyright Copyright 2001-2008 Laszlo Systems, Inc.  All Rights  
> Reserved.
>  *            Use is subject to license terms.
>  *
>  * @affects lztimer
>  * @topic LFC
>  * @subtopic Services
>  * @access public
>  */
>
> /**
>  * <p>LzTimer is used to invoke functionality after a specific
> ...

will work correctly.



More information about the Laszlo-dev mailing list