[Libreoffice] HTML formatting in comments?

Kohei Yoshida kyoshida at novell.com
Thu Feb 3 06:33:32 PST 2011


On Thu, 2011-02-03 at 12:46 +0100, 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)

I think doxygen and javadoc both support certain html tags, and I
personally find them acceptable (to a certain degree).  I myself also
use certain html tags, such as <b></b> and <i></i>, because it's useful
to emphasize certain things and some doxygen/javadoc interpreters
(including one in my editor) support some basic html tags, and they are
not that unpleasant when read in the raw form (IMO).

Having said that, I don't know about this particular tag <TRUE/> and
<FALSE/>.  This is used a lot across the code base, but I don't think
they are html tags.  I'm neutral on this; they don't bother me when I
read them, but I don't personally use them.  So, no strong opinion from
me.

Kohei

-- 
Kohei Yoshida, LibreOffice hacker, Calc
<kyoshida at novell.com>



More information about the LibreOffice mailing list