<html>
<body>
<div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
<table bgcolor="#f9f3c9" width="100%" cellpadding="12" style="border: 1px #c9c399 solid; border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;">
<tr>
<td>
This is an automatically generated e-mail. To reply, visit:
<a href="https://git.reviewboard.kde.org/r/122910/">https://git.reviewboard.kde.org/r/122910/</a>
</td>
</tr>
</table>
<br />
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: 10px;">
<p style="margin-top: 0;">On March 15th, 2015, 10:31 a.m. UTC, <b>Dominik Haumann</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: 10px;">
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; border-collapse: collapse; margin: 2px padding: 2px;">
<thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; font-size: 9pt; padding: 4px 8px; text-align: left;">
<a href="https://git.reviewboard.kde.org/r/122910/diff/1/?file=354447#file354447line36" style="color: black; font-weight: bold; text-decoration: underline;">src/kmoretools/kmoretools.h</a>
<span style="font-weight: normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">36</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "><span class="cm"> * Introduction</span></pre></td>
</tr>
</tbody>
</table>
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">Proper doxygen would look like this: The first sentence is always the "brief" documentation.
Currently, your brief documentation says "Introduction". This is certainly not what you want.</p>
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">More correct is:
/**
* Easy access to more tools.
*
* @section kmt_intro Introduction
*
* KMoreTools helps to you provide easy access to external applications ...</p>
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">It's also better to start with a true text, and not immediately with a list after a single word.</p>
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">If you want, you can have a look at e.g. ktexteditor/src/include/Document.h for how you can use doxygen to comment the code.</p>
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">Also AFAIK, it is still recomended to wrap the code and comments at latest 80 characters.</p></pre>
</blockquote>
</blockquote>
<pre style="margin-left: 1em; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">Interestingly, kapidox seems to understand the markdown synatx for headings. I tried it out (http://api.kde.org/frameworks-api/frameworks5-apidocs/kapidox/html/, sudo zypper install kapidox, kgenapidox ./frameworks/knewstuff/). It generates 3 headings (Introduction, Details and TODOs). Nevertheless, I also see now that there are plenty of issues to be fixed when I look at the generated documentation.</p></pre>
<br />
<p>- Gregor</p>
<br />
<p>On March 11th, 2015, 11:06 p.m. UTC, Gregor Mi wrote:</p>
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="12" style="border: 1px #888a85 solid; border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;">
<tr>
<td>
<div>Review request for KDE Frameworks, Emmanuel Pescosta and Jeremy Whiting.</div>
<div>By Gregor Mi.</div>
<p style="color: grey;"><i>Updated March 11, 2015, 11:06 p.m.</i></p>
<div style="margin-top: 1.5em;">
<b style="color: #575012; font-size: 10pt;">Repository: </b>
knewstuff
</div>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: 1px solid #b8b5a0">
<tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">Moved from kservice (https://git.reviewboard.kde.org/r/122576/) to here (knewstuff).</p>
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">Example usages:
- dolphin's SpaceInfoToolsMenu: https://git.reviewboard.kde.org/r/122911/
- kate's project addin: https://git.reviewboard.kde.org/r/122374/</p></pre>
</td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">
<li>src/CMakeLists.txt <span style="color: grey">(3b9a403eb473e0c3760506b2757c71d603b99775)</span></li>
<li>src/kmoretools/kmoretools.h <span style="color: grey">(PRE-CREATION)</span></li>
<li>src/kmoretools/kmoretools.cpp <span style="color: grey">(PRE-CREATION)</span></li>
<li>src/kmoretools/kmoretools_p.h <span style="color: grey">(PRE-CREATION)</span></li>
<li>src/kmoretools/kmoretoolsconfigdialog_p.h <span style="color: grey">(PRE-CREATION)</span></li>
<li>src/kmoretools/kmoretoolsconfigdialog_p.cpp <span style="color: grey">(PRE-CREATION)</span></li>
<li>src/kmoretools/ui/kmoretoolsconfigwidget.ui <span style="color: grey">(PRE-CREATION)</span></li>
<li>tests/CMakeLists.txt <span style="color: grey">(103c5fc98deaf83288b843cc66a87f2d95ad9dfb)</span></li>
<li>tests/kmoretools/1/a.desktop <span style="color: grey">(PRE-CREATION)</span></li>
<li>tests/kmoretools/1/b.desktop <span style="color: grey">(PRE-CREATION)</span></li>
<li>tests/kmoretools/1/c.desktop <span style="color: grey">(PRE-CREATION)</span></li>
<li>tests/kmoretools/2/kate.desktop <span style="color: grey">(PRE-CREATION)</span></li>
<li>tests/kmoretools/2/kate.png <span style="color: grey">(PRE-CREATION)</span></li>
<li>tests/kmoretools/2/mynotinstalledapp.desktop <span style="color: grey">(PRE-CREATION)</span></li>
<li>tests/kmoretools/2/mynotinstalledapp.png <span style="color: grey">(PRE-CREATION)</span></li>
<li>tests/kmoretools/kmoretoolstest.cpp <span style="color: grey">(PRE-CREATION)</span></li>
</ul>
<p><a href="https://git.reviewboard.kde.org/r/122910/diff/" style="margin-left: 3em;">View Diff</a></p>
</td>
</tr>
</table>
</div>
</body>
</html>