Review Request 119997: Add documentation to KConfig::sync()

[Martin Klapetek]

> On Srp. 31, 2014, 6:57 dop., Matthew Dawson wrote:
> > Thanks for taking a look at this.  It appears KConfigBase isn't available on api.kde.org as it isn't documented, as kapidox hides such classes by default.  As KConfigBase is used outside of KConfig, I'd prefer if KConfigBase gained a quick blurb to copying its documentation.  I think something describing it as a way for a function to accept either a KConfig or a KConfigGroup and be able load/persist its settings would be good.

KConfigBase is very much documented, see [1]. I don't know why it's not showing up...nevertheless, if that method is reimplementation of the base class method, it should imho has its own documentation altogether (it's *reimplementation* after all). What I did here is just a quick fix to improve that...

[1] - http://quickgit.kde.org/?p=kconfig.git&a=blob&h=3d00d98a1eb565df1a6eea2eba165bfeda17978b&hb=5941a608038d799244ba2dfdceb2da8bf1685fc1&f=src%2Fcore%2Fkconfigbase.h


- Martin


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/119997/#review65567
-----------------------------------------------------------


On Srp. 29, 2014, 11:42 odp., Martin Klapetek wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/119997/
> -----------------------------------------------------------
> 
> (Updated Srp. 29, 2014, 11:42 odp.)
> 
> 
> Review request for KDE Frameworks.
> 
> 
> Repository: kconfig
> 
> 
> Description
> -------
> 
> The docs at api.kde.org shows just "Reimplemented from superclass." for the sync() method, however the superclass, KConfigBase, is not available at the api.kde.org. So this copies the documentation from KConfigBase to KConfig so the text can actually be visible at api.kde.org
> 
> 
> Diffs
> -----
> 
>   src/core/kconfig.h d7d4b7d 
> 
> Diff: https://git.reviewboard.kde.org/r/119997/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Martin Klapetek
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140831/73ca0de8/attachment.html>