RE: [Vxl-maintainers] Ambiguity in VXL to Doxygen comment conversion

[Ian S. <ian...@st...>]

> How do I create a multiline <IMS> brief </IMS> comment using VXL's EOL-
> comment-only style?  Thusly (form 1b):

You don't

The point of brief comments is that they are brief!
You have about 132 (-4 for //: ) characters to play with,
although we prefer to have lines no longer than 80 chars.

It doesn't matter if your description isn't complete. The
long description is for the details.

Ian.

> -----Original Message-----
> From: rob...@at... [mailto:rob...@at...]
> Sent: Monday, February 04, 2002 2:24 PM
> To: vxl...@li...
> Subject: [Vxl-maintainers] Ambiguity in VXL to Doxygen comment
> conversion
> 
> 
> The sample documentation files, vxl_doc_rules.h and 
> vxl_doc_rules.cxx, aren't clear on this point.  I do 
> not have Perl installed and I don't know Perl, so I 
> can't figure it out experimentally or from the source.  
> (I'll install Perl shortly.)  If someone answers my 
> question, I'll submit a clarifying patch to the 
> vxl_doc_rules files.
> 
> In Doxygen, a multi-line brief description can be 
> created thusly (form 1a):
> 
> //! Line 1
> //! Line 2
> 
> or thusly (form 2a):
> 
> /*!
>   \brief Line 1
>   Line 2
> 
>   The space after line 2 ends the brief description.
>   This is part of the detailed description.
> */
> 
> How do I create a multiline comment using VXL's EOL-
> comment-only style?  Thusly (form 1b):
> 
> //: Brief line1
> // Brief line 2
> //
> // Detailed line 1
> // Detailed line 2
> 
> or thusly (form 2b):
> 
> //: Brief line 1
> //: Brief line 2
> //
> // Detailed line 1
> // Detailed line 2
> 
> Thanks,
> Rob Campbell
> rob...@at...
> 
> _______________________________________________
> Vxl-maintainers mailing list
> Vxl...@li...
> https://lists.sourceforge.net/lists/listinfo/vxl-maintainers
>