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

List:       kde-commits
Subject:    koffice/lib/kofficeui
From:       Adriaan de Groot <groot () kde ! org>
Date:       2005-10-10 7:47:36
Message-ID: 1128930456.902986.28908.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 469125 by adridg:

DOX: repair broken @param names.

Editorial: there are two other classes -- GuideLineData and 
GuideLineList -- with no dox in this file; those should be
added. Or perhaps the Data class can be moved to the C++ file?
It's not clear to me that it needs to be used anywhere else.

Editorial: good dox coverage! While it's not necessary to
document private members (as far as the API is concerned),
doing so makes the code more accessible to new developers.

Editorial: void guideLinesChanged() could use a @param
explaining what the View * parameter in the signal means.

CCMAIL: zachmann@kde.org


 M  +1 -1      koGuideLines.h  


--- trunk/koffice/lib/kofficeui/koGuideLines.h #469124:469125
@@ -161,7 +161,7 @@
      *
      * Erases the guide lines from the buffer and if set also from the canvas. 
      *
-     * @param updateView If ture it also updates the canvas of the view.
+     * @param updateCanvas If true it also updates the canvas of the view.
      */
     void erase( bool updateCanvas = true );
 
[prev in list] [next in list] [prev in thread] [next in thread]