Huggle: Document header files where needed
completed by: Robert Hönig
mentors: Petr Bena
Huggle is a fast diff browser application intended for dealing with vandalism on Wikimedia projects, written in C++ (C++11 with Qt framework). More information: https://meta.wikimedia.org/wiki/Huggle and https://en.wikipedia.org/wiki/Wikipedia:Huggle. Source code is available at https://github.com/huggle/huggle3-qt-lx and can be compiled on Linux, Windows and MacOS.
Huggle is using a doxygen documentation that can be found at https://tools.wmflabs.org/huggle/docs/head/
This documentation is generated from header files that are using doxygen format, however lot of them are missing the documentation and that makes it harder for developers to understand how they work. It is needed to find headers where documentation is missing for classes, public variables or functions. These headers then need to be updated in same fashion as for example https://github.com/huggle/huggle3-qt-lx/blob/master/huggle/hugglefeed.hpp
The doxygen example format:
* \brief RevertEdit Reverts the edit
* \param _e Pointer to edit that needs to be reverted
* \param summary Summary to use if this is empty the default revert summary is used
* \param minor If revert should be considered as minor edit
* \param rollback If rollback feature should be used
* \return Pointer to api query that executes this revert
HUGGLE_EX Collectable_SmartPtr<RevertQuery> RevertEdit(WikiEdit* _e, QString summary = "", bool minor = false, bool rollback = true);
In order to complete this task, at least 20 variables or functions needs to be completely commented across header files (so it can be 10 in one header, 20 in another etc). Only public functions, variables and classes need comments.
NOTE: You don't need to fully understand the code in order to do this task, if you are not sure what some variable or function is for, you are welcome to ask either here, or using huggle mailing list or our irc channel #huggle on freenode.
Students are required to read Wikimedia's general instructions at https://www.mediawiki.org/wiki/Google_Code-in_2014#Instructions_for_GCI_students first.