Differential D17802

Hide API documentation of internal classes
ClosedPublic
Actions

Authored by vkrause on Dec 25 2018, 9:27 PM.

Details

Reviewers
dhaumann
Commits
R289:e3d07cec0b6f: Hide API documentation of internal classes

Diff Detail

Repository
R289 KNotifications
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
vkrause created this revision.Dec 25 2018, 9:27 PM
Restricted Application added a project: Frameworks. · View Herald TranscriptDec 25 2018, 9:27 PM
Restricted Application added a subscriber: kde-frameworks-devel. · View Herald Transcript
vkrause requested review of this revision.Dec 25 2018, 9:27 PM
dhaumann accepted this revision.Dec 26 2018, 10:14 AM
dhaumann added a subscriber: dhaumann.

A bit more verbose description on why this patch is needed and a link to the generated page on api.kde.org would be useful :)

PS: KTextEditor also shows hundreds of classes that are internal API. Only the classes in the KTextEditor namespace are public (unfortunately, this fact is mostly only known by KTextEditor developers).

This revision is now accepted and ready to land.Dec 26 2018, 10:14 AM
Closed by commit R289:e3d07cec0b6f: Hide API documentation of internal classes (authored by vkrause). · Explain WhyDec 26 2018, 10:36 AM
This revision was automatically updated to reflect the committed changes.
dhaumann added a comment.Dec 26 2018, 8:45 PM

Another solution is to mark the class @internal. It is still visible then on api.kde.org, though.

Revision Contents
Changeset List

PathPackages
AMdocs/Doxyfile.local (1 line)

Diff 48216

View Options

docs/Doxyfile.local

Loading...