Re: Doxygen comments

Posted by David Haslam on
URL: http://digikam.185.s1.nabble.com/Doxygen-comments-tp4714695p4714700.html

Thanks, and Happy New Year to all.

On 05/01/2021 16:47, Gilles Caulier wrote:

Hi and happy new year.

All pull requests are welcome of course, especially brief descriptions
of classes.

Doxygen comment in digiKam use /** ... */

For inline comment, we use ///< ...

Best regards

Gilles Caulier

Le mar. 5 janv. 2021 à 17:43, David Haslam [hidden email] a écrit :

When I submit fixes, is it acceptable to also add new doxygen comments? In particular, I'd like to at least add \brief class descriptions where I've worked out what something does.

Also, is there any preference for the comment style: /**, ///, /*!, //!

--

David