[Differential] [Commented On] D3636: [kconfig_compiler] Improve documentation about Inherits

[dfaure (David Faure)]

dfaure added inline comments.

INLINE COMMENTS

> nalvarez wrote in README.dox:111
> an ctor -> a ctor.
> 
> Also, would it make sense to explain here what those arguments //are//, or is that explained later?

Also, "empty ctor" sounds like the body should be empty. I think you meant "a default constructor".

(BTW I would spell out "constructor" instead of using an abbreviation)

Nicolas: indeed it's not clear what the QString is, in this sentence, so rather than duplicating the API documentation for KConfigSkeleton, I suppose this could say:

"and must provide a default constructor, a constructor taking a QString argument (see the one in KConfigSkeleton), and a constructor taking a KSharedConfig::Ptr as argument (see the one in KConfigSkeleton)."

REPOSITORY
  R237 KConfig

REVISION DETAIL
  https://phabricator.kde.org/D3636

EMAIL PREFERENCES
  https://phabricator.kde.org/settings/panel/emailpreferences/

To: graesslin, #frameworks, dfaure, mdawson
Cc: nalvarez
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20161212/d4be064f/attachment-0001.html>