Review Request: Better documentation for KConfigDialog::addPage()

[Aaron J. Seigo]

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

Ship it!


i think it could be made even clearer (see comment below), but regardless of the verbage, such a clarification should be pushed into master.


kdeui/dialogs/kconfigdialog.h
<http://git.reviewboard.kde.org/r/101409/#comment2888>

    even clearer might be something like:
    
    "Name of the icon that should be used, if needed, when displaying the page. The string may either be the name of a themed icon (e.g. "document-save"), which the internal icon loader will be used to retrieve, or an absolute path to the pixmap on disk."
    


- Aaron J.


On May 21, 2011, 8:30 a.m., Lukas Sommer wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/101409/
> -----------------------------------------------------------
> 
> (Updated May 21, 2011, 8:30 a.m.)
> 
> 
> Review request for kdelibs.
> 
> 
> Summary
> -------
> 
> The documentation of KConfigDialog::addPage() is not very detailed about the parameter "pixmapName". This patch adds to the documentation that it is possible to simply pass the KDE icon name instead of the pixmap path.
> 
> 
> This addresses bug 273723.
>     http://bugs.kde.org/show_bug.cgi?id=273723
> 
> 
> Diffs
> -----
> 
>   kdeui/dialogs/kconfigdialog.h 873460b 
> 
> Diff: http://git.reviewboard.kde.org/r/101409/diff
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Lukas
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-core-devel/attachments/20110521/4678c2bb/attachment.htm>