D8211: KDevelop/Documentation : implementation of a QTextBrowser-based viewer

René J.V. Bertin noreply at phabricator.kde.org
Thu Oct 19 16:03:23 UTC 2017


rjvbb added inline comments.

INLINE COMMENTS

> kossebau wrote in standarddocumentationview.cpp:419
> Can be removed, useless with current content of source file, nothing needs to be moc'ed here.

I'll double-check. This will also contain to-be-moc-ed things from standarddocumentationview.h .

> kossebau wrote in standarddocumentationview.h:74
> Why is this method not in #ifdef USE_QTEXTBROWSER?

I've hesitated about that. It can be of course. I've left it here for now, in case anyone wants to extends the QWE or QWK backends in a similar way with a callback into the QtHelp (or other) plugin.
(I won't be the one doing that, so I don't care where we put this.)

> kossebau wrote in standarddocumentationview.h:76
> KDevelop::StandardDocumentationView is part of the public KDevPlatformDocumentation API,  standarddocumentationview.h is an installed header.
> 
> Having a part of the public API only created depending on build-time config settings needs this settings also be deployed with the installed headers.

You're saying I have 2 simple choices here:

- remove #ifdef in the headerfile and provide (stub) implementations for the QtWeb* configuration
- add the USE_QTEXTBROWSER flag in a generated headerfile so that the setting becomes available publicly. This would probably also mean that the flag best become under direct control of a cmake option.

Come to think of it, the 2nd option is probably the way to go in case there are contributed documentation plugins (are there?).

Do we agree on the name or should I use something else?

REPOSITORY
  R32 KDevelop

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

To: rjvbb, #kdevelop
Cc: kossebau, aaronpuchert, flherne, arichardson, apol, kdevelop-devel, geetamc, Pilzschaf, akshaydeo, surgenight, arrowdodger
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kdevelop-devel/attachments/20171019/fbb202af/attachment.html>


More information about the KDevelop-devel mailing list