← Back to team overview

kicad-developers team mailing list archive

Re: [PATCH] Doxygen improvements

 

Simon,

Nice work!  Thank you for setting this up.  This is a very useful
resource for those of us who manage to make a mess of the Doxygen
comments from time to time.  To all our developers out there, please
take a look at the list of files with Doxygen warnings and see if there
is anything with your name all over it an try to fix the Doxygen
warnings when you get a chance.  I already saw a few with my name. ;)

Cheers,

Wayne

On 6/11/2017 1:43 AM, Simon Richter wrote:
> Hi,
> 
> On 11.06.2017 07:38, Simon Richter wrote:
> 
>>  3d-viewer/3d_cache/3d_cache.h             | 22 ++++++++++++----------
>>  3d-viewer/3d_cache/3d_filename_resolver.h |  7 ++++---
> 
> In case anyone else wants to fix problems with the Doxygen
> documentation, there is a Jenkins job now that reports warnings (like
> partially documented functions and mismatching parameter names).
> 
> The current list of problems in the Doxygen comments can be found at
> 
> https://guava.hogyros.de/job/any-kicad-doxygen/warnings15
> 
> The nightly build of Doxygen documentation can be found at
> 
> https://guava.hogyros.de/job/any-kicad-doxygen/lastSuccessfulBuild/artifact/Documentation/doxygen/html/index.html
> 
>    Simon
> 
> 
> 
> _______________________________________________
> Mailing list: https://launchpad.net/~kicad-developers
> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
> 



References