Contributing to Class Reference Documentation

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Contributing to Class Reference Documentation

kartikx
Hello,

What is the procedure for editing the DigiKam Class Reference page documentation? (https://www.digikam.org/api/annotated.html)
I've been referencing this to understand the codebase, and came across a few grammatical errors, that I may fix.

Thanks,
Kartik.
Reply | Threaded
Open this post in threaded view
|

Re: Contributing to Class Reference Documentation

Gilles Caulier-4
Hi,

All the API doc is written in the code using Doxygen. So, find the
right class twitch the type, fix the doc comment and make a patch (or
use a gitlab fork with a Commit Request to sync back).

Best

Gilles Caulier

Le mer. 11 mars 2020 à 07:29, Kartik Ramesh <[hidden email]> a écrit :
>
> Hello,
>
> What is the procedure for editing the DigiKam Class Reference page documentation? (https://www.digikam.org/api/annotated.html)
> I've been referencing this to understand the codebase, and came across a few grammatical errors, that I may fix.
>
> Thanks,
> Kartik.