Re: Code documentation - doxygen

2012-07-17 Thread Jan Holesovsky
Hi Lubos, Faisal, On 2012-07-17 at 11:53 +0200, Lubos Lunak wrote: > That is actually not doxygen markup either, it should be ///< . See > http://wiki.documentfoundation.org/Development/Doxygen . Ah right, fixed such occurrences in the headers: http://cgit.freedesktop.org/libreoffice/core/com

Re: Code documentation - doxygen

2012-07-17 Thread Lubos Lunak
On Tuesday 17 of July 2012, Jan Holesovsky wrote: > >From my point of view, there are many comments that might be useful, but > > just lack the doxygen markup; like member variables that are commented > in the header files like > > int m_nSomething; // this counts this and that > > which would

Re: Code documentation - doxygen

2012-07-17 Thread Michael Meeks
Hi Faisal, On Tue, 2012-07-17 at 11:05 +0200, Jan Holesovsky wrote: > On 2012-07-16 at 10:46 +, Faisal M. Alotaibi wrote: > > We are going to help in code documentation through doxygen. so > > before we start we would like to know > > if there any module that you

Re: Code documentation - doxygen

2012-07-17 Thread Jan Holesovsky
Hi Faisal, On 2012-07-16 at 10:46 +, Faisal M. Alotaibi wrote: > We are going to help in code documentation through doxygen. so > before we start we would like to know > if there any module that you suggest to start with? Thank you for that - that would be great! What exactl

Code documentation - doxygen

2012-07-16 Thread Faisal M. Alotaibi
Hi, We are going to help in code documentation through doxygen. so before we start we would like to know if there any module that you suggest to start with? __ Regards, Faisal M.Al-Otaibi Programmer. Motah Program, KACST http://www.motah.org.sa Warning: This message and

Re: Code documentation

2012-07-16 Thread Lubos Lunak
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 function

Re: Code documentation

2012-07-16 Thread Thorsten Behrens
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 ? > Hi Jean-Tiare, yes, that would be awesome - > If this is OK, where shoul

Code documentation

2012-07-16 Thread Jean-Tiare LE BIGOT
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 ? If this is OK, where should I add them ? In the header files or in the implementation files ? -- Jean-Tiare