<div dir="ltr"><div>Hi all,</div><div><br></div><div>Recently, few people ask in this room to find information about how to contribute to digiKam project.</div><div><br></div><div>The current guide to contribute available on web site are completly broken :</div><div><br></div><div><a href="https://api.kde.org/extragear-api/graphics-apidocs/digikam/html/index.html">https://api.kde.org/extragear-api/graphics-apidocs/digikam/html/index.html</a><br></div><div><br></div><div>This point on obscur API from internal Upnp sdk that we don't care and that i voluntary disable in doxygen config from digiKam core.</div><div><br></div><div>After 2 days to try to fix this problem, i lost the way to use the KDE API online site to export the digiKam Doxygen documentation. This do not work and do not follow the long settings that i write to optimize the output. This settings is located in Doxyfile from root source directory.</div><div><br></div><div>As I already said previously, KDE project sound lost to do to much work and the basis do not work or with the time stop to work.</div><div><br></div><div>I want something working well, simple to drive and configure. The optimum solution is to export the API doc generated locally, which respect my settings and do the job quickly. As i already said previously, my time is precious and i don't wont to lost my to time to learn again to drive my car.</div><div><br></div><div>So the script is simple and is located in project/scripts/exportapi.sh.</div><div><br></div><div>The result is here :</div><div><br></div><div><a href="https://www.digikam.org/api/">https://www.digikam.org/api/</a><br></div><div><br></div><div>As you can see, i started to merge a lots of developers documentation from everywhere. The goal is to have a main page with all necessary grouped to start to contribute to the project. I also limited to documentation settings to the public API documentation, with few class graph. </div><div><br></div><div>Here the main page is very important and contents is simply located to Mainpage.dox file from root source directory.</div><div><br></div><div>It still a lots of pending task to do :</div><div><br></div><div>- Write a lots of pointer to main and most important classes from digiKam core.</div><div>- Add more description in classes documentation. Few are well documented, other one, no. It's now the time make pointers better for new contributors.<br></div><div>- Import the cmake documentation explaining how the compilation rules is written to compile quickly the whole project. See this documentation to import and update in doxygen :</div><div><br></div><div><a href="https://community.kde.org/Digikam/CMake_Documentation(Frameworks)">https://community.kde.org/Digikam/CMake_Documentation(Frameworks)</a><br></div><div><br></div><div>To the question about "why not to use the KDE wiki instead git/doxygen implementation", my response is simple : in the past, we use a lots of wiki page to write the doc, and in one day, we lost all the contents due to a wiki manager update. So the ulimate solution is to use git and doxygen, that all...</div><div><br></div><div>Voilà</div><div><br></div>Gilles Caulier</div>