[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-core-devel
Subject:    Re: Review Request: Replace doxygen tag @arg by @param.
From:       "Frederik Schwarzer" <schwarzer () kde ! org>
Date:       2011-06-13 16:29:16
Message-ID: 20110613162916.20882.15200 () vidsolbach ! de
[Download RAW message or body]

> On June 13, 2011, noon, Allen Winter wrote:
> > yep

Committted in be5406fa87bc406c7a5ac4896fa623197738d914.


- Frederik


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://git.reviewboard.kde.org/r/101596/#review3866
-----------------------------------------------------------


On June 12, 2011, 7:59 p.m., Frederik Schwarzer wrote:
> =

> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/101596/
> -----------------------------------------------------------
> =

> (Updated June 12, 2011, 7:59 p.m.)
> =

> =

> Review request for kdelibs.
> =

> =

> Summary
> -------
> =

> The @param doxygen tag is formatted way nicer and should be used througho=
ut our apidox.
> =

> There are no further changes here. Only @arg -> @param and three fixes wh=
ere the param name was not stated.
> =

> The formatting chanes from something like:
> =

> =

>   Defaults to the application wide default font.
> =

>   - font the new font
>   - role which role (usage pattern) to set the font for
> =

> =

> to:
> =

> =

>   Defaults to the application wide default font.
> =

>   Parameters:
>     <em>font</em> the new font
>     <em>role</em> which role (usage pattern) to set the font for
> =

> =

> Diffs
> -----
> =

>   kdecore/config/kconfig.h e920114 =

>   kjsembed/kjsembed/binding_support.h f06f090 =

>   kjsembed/kjsembed/static_binding.h 523d7b9 =

>   plasma/abstractrunner.h aabc805 =

>   plasma/animations/animation.h dae4a0d =

>   plasma/animations/geometry_p.h 47f4006 =

>   plasma/animations/rotation_p.h 2d898a3 =

>   plasma/animations/rotationstacked_p.h 6771b8f =

>   plasma/animations/slide_p.h 3e4ab39 =

>   plasma/animator.h 797c05e =

>   plasma/applet.h a417dfd =

>   plasma/configloader.h 4ae0ef0 =

>   plasma/containment.h c60eda0 =

>   plasma/containmentactions.h 5ab4570 =

>   plasma/corona.h 4104ff6 =

>   plasma/dialog.h 4c4ef12 =

>   plasma/framesvg.h d43e253 =

>   plasma/glapplet.h f264bd3 =

>   plasma/package.h 15b22dd =

>   plasma/packagemetadata.h 5fa72e9 =

>   plasma/packagestructure.h b2f2e43 =

>   plasma/plasma.h 5ed8981 =

>   plasma/popupapplet.h cc80625 =

>   plasma/remote/accessappletjob.h b13dd9d =

>   plasma/remote/serviceaccessjob.h 0225f77 =

>   plasma/runnercontext.h cfb956e =

>   plasma/runnermanager.h 341d22f =

>   plasma/runnersyntax.h 690a734 =

>   plasma/scripting/appletscript.h 424690c =

>   plasma/scripting/scriptengine.h 610c10e =

>   plasma/service.h 126ea6f =

>   plasma/servicejob.h 30660c5 =

>   plasma/svg.h 3b640ac =

>   plasma/theme.h f74a959 =

>   plasma/tooltipmanager.h 083feae =

>   plasma/view.h 2489ec5 =

>   plasma/wallpaper.h e2d3926 =

>   plasma/widgets/busywidget.h e14ec4f =

>   plasma/widgets/checkbox.h 6e8d77f =

>   plasma/widgets/combobox.h 142b587 =

>   plasma/widgets/frame.h be1b1ee =

>   plasma/widgets/groupbox.h 91d76b0 =

>   plasma/widgets/iconwidget.h 7a4c298 =

>   plasma/widgets/itembackground.h 4e87d23 =

>   plasma/widgets/label.h 17f8bbd =

>   plasma/widgets/lineedit.h 524bc9e =

>   plasma/widgets/pushbutton.h 7819c8f =

>   plasma/widgets/radiobutton.h 6cec317 =

>   plasma/widgets/scrollbar.h 7ed6190 =

>   plasma/widgets/scrollwidget.h ad15a38 =

>   plasma/widgets/slider.h a9834fd =

>   plasma/widgets/spinbox.h fdced70 =

>   plasma/widgets/tabbar.h b6c3f86 =

>   plasma/widgets/textbrowser.h ca5ab47 =

>   plasma/widgets/textedit.h 1c4e4b8 =

>   plasma/widgets/toolbutton.h 77f48dc =

>   plasma/widgets/treeview.h 2d753ad =

>   plasma/widgets/videowidget.h 267c313 =

>   plasma/windoweffects.h 80534ee =

> =

> Diff: http://git.reviewboard.kde.org/r/101596/diff
> =

> =

> Testing
> -------
> =

> =

> Thanks,
> =

> Frederik
> =

>


[Attachment #3 (text/html)]

<html>
 <body>
  <div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
   <table bgcolor="#f9f3c9" width="100%" cellpadding="8" style="border: 1px #c9c399 \
solid;">  <tr>
     <td>
      This is an automatically generated e-mail. To reply, visit:
      <a href="http://git.reviewboard.kde.org/r/101596/">http://git.reviewboard.kde.org/r/101596/</a>
  </td>
    </tr>
   </table>
   <br />





<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;">  <p style="margin-top: 0;">On June 13th, 2011, noon, <b>Allen Winter</b> \
wrote:</p>  <blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; \
padding-left: 10px;">  <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; \
white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">yep</pre>  \
</blockquote>







</blockquote>

<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Committted in \
be5406fa87bc406c7a5ac4896fa623197738d914.</pre> <br />








<p>- Frederik</p>


<br />
<p>On June 12th, 2011, 7:59 p.m., Frederik Schwarzer wrote:</p>






<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="8" \
style="background-image: \
url('http://git.reviewboard.kde.org/media/rb/images/review_request_box_top_bg.png'); \
background-position: left top; background-repeat: repeat-x; border: 1px black \
solid;">  <tr>
  <td>

<div>Review request for kdelibs.</div>
<div>By Frederik Schwarzer.</div>


<p style="color: grey;"><i>Updated June 12, 2011, 7:59 p.m.</i></p>




<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;">The @param doxygen tag is formatted way nicer and should be used \
throughout our apidox.

There are no further changes here. Only @arg -&gt; @param and three fixes where the \
param name was not stated.

The formatting chanes from something like:


  Defaults to the application wide default font.

  - font the new font
  - role which role (usage pattern) to set the font for


to:


  Defaults to the application wide default font.

  Parameters:
    &lt;em&gt;font&lt;/em&gt; the new font
    &lt;em&gt;role&lt;/em&gt; which role (usage pattern) to set the font for
</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>kdecore/config/kconfig.h <span style="color: grey">(e920114)</span></li>

 <li>kjsembed/kjsembed/binding_support.h <span style="color: \
grey">(f06f090)</span></li>

 <li>kjsembed/kjsembed/static_binding.h <span style="color: \
grey">(523d7b9)</span></li>

 <li>plasma/abstractrunner.h <span style="color: grey">(aabc805)</span></li>

 <li>plasma/animations/animation.h <span style="color: grey">(dae4a0d)</span></li>

 <li>plasma/animations/geometry_p.h <span style="color: grey">(47f4006)</span></li>

 <li>plasma/animations/rotation_p.h <span style="color: grey">(2d898a3)</span></li>

 <li>plasma/animations/rotationstacked_p.h <span style="color: \
grey">(6771b8f)</span></li>

 <li>plasma/animations/slide_p.h <span style="color: grey">(3e4ab39)</span></li>

 <li>plasma/animator.h <span style="color: grey">(797c05e)</span></li>

 <li>plasma/applet.h <span style="color: grey">(a417dfd)</span></li>

 <li>plasma/configloader.h <span style="color: grey">(4ae0ef0)</span></li>

 <li>plasma/containment.h <span style="color: grey">(c60eda0)</span></li>

 <li>plasma/containmentactions.h <span style="color: grey">(5ab4570)</span></li>

 <li>plasma/corona.h <span style="color: grey">(4104ff6)</span></li>

 <li>plasma/dialog.h <span style="color: grey">(4c4ef12)</span></li>

 <li>plasma/framesvg.h <span style="color: grey">(d43e253)</span></li>

 <li>plasma/glapplet.h <span style="color: grey">(f264bd3)</span></li>

 <li>plasma/package.h <span style="color: grey">(15b22dd)</span></li>

 <li>plasma/packagemetadata.h <span style="color: grey">(5fa72e9)</span></li>

 <li>plasma/packagestructure.h <span style="color: grey">(b2f2e43)</span></li>

 <li>plasma/plasma.h <span style="color: grey">(5ed8981)</span></li>

 <li>plasma/popupapplet.h <span style="color: grey">(cc80625)</span></li>

 <li>plasma/remote/accessappletjob.h <span style="color: grey">(b13dd9d)</span></li>

 <li>plasma/remote/serviceaccessjob.h <span style="color: grey">(0225f77)</span></li>

 <li>plasma/runnercontext.h <span style="color: grey">(cfb956e)</span></li>

 <li>plasma/runnermanager.h <span style="color: grey">(341d22f)</span></li>

 <li>plasma/runnersyntax.h <span style="color: grey">(690a734)</span></li>

 <li>plasma/scripting/appletscript.h <span style="color: grey">(424690c)</span></li>

 <li>plasma/scripting/scriptengine.h <span style="color: grey">(610c10e)</span></li>

 <li>plasma/service.h <span style="color: grey">(126ea6f)</span></li>

 <li>plasma/servicejob.h <span style="color: grey">(30660c5)</span></li>

 <li>plasma/svg.h <span style="color: grey">(3b640ac)</span></li>

 <li>plasma/theme.h <span style="color: grey">(f74a959)</span></li>

 <li>plasma/tooltipmanager.h <span style="color: grey">(083feae)</span></li>

 <li>plasma/view.h <span style="color: grey">(2489ec5)</span></li>

 <li>plasma/wallpaper.h <span style="color: grey">(e2d3926)</span></li>

 <li>plasma/widgets/busywidget.h <span style="color: grey">(e14ec4f)</span></li>

 <li>plasma/widgets/checkbox.h <span style="color: grey">(6e8d77f)</span></li>

 <li>plasma/widgets/combobox.h <span style="color: grey">(142b587)</span></li>

 <li>plasma/widgets/frame.h <span style="color: grey">(be1b1ee)</span></li>

 <li>plasma/widgets/groupbox.h <span style="color: grey">(91d76b0)</span></li>

 <li>plasma/widgets/iconwidget.h <span style="color: grey">(7a4c298)</span></li>

 <li>plasma/widgets/itembackground.h <span style="color: grey">(4e87d23)</span></li>

 <li>plasma/widgets/label.h <span style="color: grey">(17f8bbd)</span></li>

 <li>plasma/widgets/lineedit.h <span style="color: grey">(524bc9e)</span></li>

 <li>plasma/widgets/pushbutton.h <span style="color: grey">(7819c8f)</span></li>

 <li>plasma/widgets/radiobutton.h <span style="color: grey">(6cec317)</span></li>

 <li>plasma/widgets/scrollbar.h <span style="color: grey">(7ed6190)</span></li>

 <li>plasma/widgets/scrollwidget.h <span style="color: grey">(ad15a38)</span></li>

 <li>plasma/widgets/slider.h <span style="color: grey">(a9834fd)</span></li>

 <li>plasma/widgets/spinbox.h <span style="color: grey">(fdced70)</span></li>

 <li>plasma/widgets/tabbar.h <span style="color: grey">(b6c3f86)</span></li>

 <li>plasma/widgets/textbrowser.h <span style="color: grey">(ca5ab47)</span></li>

 <li>plasma/widgets/textedit.h <span style="color: grey">(1c4e4b8)</span></li>

 <li>plasma/widgets/toolbutton.h <span style="color: grey">(77f48dc)</span></li>

 <li>plasma/widgets/treeview.h <span style="color: grey">(2d753ad)</span></li>

 <li>plasma/widgets/videowidget.h <span style="color: grey">(267c313)</span></li>

 <li>plasma/windoweffects.h <span style="color: grey">(80534ee)</span></li>

</ul>

<p><a href="http://git.reviewboard.kde.org/r/101596/diff/" style="margin-left: \
3em;">View Diff</a></p>




  </td>
 </tr>
</table>








  </div>
 </body>
</html>



[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic