Code documentation

Lubos Lunak l.lunak at suse.cz
Mon Jul 16 02:07:51 PDT 2012


On Sunday 15 of July 2012, Jean-Tiare LE BIGOT wrote:
> I'm new to LibreOffice code base and I'm working on one of the easy
> hacks to get started. It seems that most functions are note documented.
> Is that OK if I add some doxygen style comments ?

 It's most welcome. Just note that some functions have rather obscure 
non-intuitive functionality, so be be careful you know that the function 
actually does what you think it does.

> If this is OK, where should I add them ? In the header files or in the
> implementation files ?

 The common practice is headers. See also
 https://wiki.documentfoundation.org/Development/Doxygen .

-- 
 Lubos Lunak
 l.lunak at suse.cz


More information about the LibreOffice mailing list