[Libreoffice] HTML formatting in comments?

[Cedric Bosdonnat]

You need to pay attention to the internal javadoc-like tool used for IDL
files and some hxx files as well. This has some special tags... all the
doc is here:

http://api.openoffice.org/docs/DevelopersGuide/Appendix/IDLDocumentationGuide/IDLDocumentationGuide.xhtml

<TRUE/> and <FALSE/> are valid for this one. I would be in favor of
removing the use of that tool in C++ code and replace it by doxygen
comments... Keeping that thing for IDL only would be nice.

Regards,

On Thu, 2011-02-03 at 17:41 +0100, Thomas Arnhold wrote:
> In addition to this:
> 
> There's the possibility to define multiple return values with \retval.
> So we would get a nice formatted list like with param.
> 
> From the doxyfile documentation:
> -----
> \retval <return value> { description }
> 
> Starts a description for a function's return value with name <return
> value>, followed by a description of the return value. The text of the
> paragraph that forms the description has no special internal structure.
> All visual enhancement commands may be used inside the paragraph.
> Multiple adjacent \retval commands will be joined into a single
> paragraph. Each return value description will start on a new line. The
> \retval description ends when a blank line or some other sectioning
> command is encountered.
> -----
> 
> I think it would be nice to use this. I could write a simple script
> which replaces TRUE/FALSE with @retval.
> 
> Thomas
> 
> On 02/03/2011 04:28 PM, Thomas Arnhold wrote:
> > Hi Christina,
> > 
> > seems like a XHMTL or XML tag. But doxygen doesn't know them. Here is
> > the list of known tags to doxygen:
> > 
> > http://www.stack.nl/~dimitri/doxygen/htmlcmds.html
> > http://www.stack.nl/~dimitri/doxygen/xmlcmds.html
> > 
> > If you run doxygen it says: "Unsupported xml/html tag <TRUE> found". So
> > you're right. We could simply replace this with TRUE and FALSE.
> > 
> > Thomas
> > 
> > On 02/03/2011 12:46 PM, Christina Roßmanith wrote:
> >> Hi,
> >>
> >> I came across comments with html formatting which makes it difficult to
> >> read them. Can this formatting be removed?
> >>
> >> example: <TRUE/> if and only if parsing was successful, <FALSE/> if
> >> default handling should...
> >> (file: libs-core/connectivity/inc/connectivity/sqlnode.hxx)
> >>
> >> Christina Rossmanith
> >> _______________________________________________
> >> LibreOffice mailing list
> >> LibreOffice at lists.freedesktop.org
> >> http://lists.freedesktop.org/mailman/listinfo/libreoffice
> >>
> > 
> > _______________________________________________
> > LibreOffice mailing list
> > LibreOffice at lists.freedesktop.org
> > http://lists.freedesktop.org/mailman/listinfo/libreoffice
> > 
> 
> _______________________________________________
> LibreOffice mailing list
> LibreOffice at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/libreoffice

-- 
Cédric Bosdonnat
LibreOffice hacker
http://documentfoundation.org
OOo Eclipse Integration developer
http://cedric.bosdonnat.free.fr