KF API Documentation proposed, small, addition
Ahmad Samir
a.samirh78 at gmail.com
Mon Aug 30 13:17:42 BST 2021
I would like to add the following to:
https://community.kde.org/Frameworks/Frameworks_Documentation_Policy#Document_the_Classes
One can use [https://www.doxygen.nl/manual/commands.html Doxygen commands] to improve readability,
for example
* @c which will make the word after it use a monospace/typewriter font face, typically e.g. @c true,
@c false, @c setSomeValue(); for multiple words you'll have to use:
<pre><tt>multiple words</tt></pre>
* @copydoc to copy the docs of a different method, e.g. if one method overloads another
--
Ahmad Samir
More information about the Kde-frameworks-devel
mailing list