Bug 406850 - Undocumented classes are missing in api doc
Summary: Undocumented classes are missing in api doc
Status: REPORTED
Alias: None
Product: frameworks-kapidox
Classification: Frameworks and Libraries
Component: general (show other bugs)
Version: unspecified
Platform: Other All
: NOR wishlist
Target Milestone: ---
Assignee: kdelibs bugs
URL:
Keywords:
: 217529 (view as bug list)
Depends on:
Blocks:
 
Reported: 2019-04-24 17:00 UTC by Andrey Bondarenko
Modified: 2019-05-14 19:37 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:

Attachments
Add an attachment

Note You need to log in before you can comment on or make changes to this bug.
Description Andrey Bondarenko 2019-04-24 17:00:22 UTC 
API doc generated by kapidox_generate does not include class, if it does not have doxygen comment block. 

This is configured in Doxyfile.global with HIDE_UNDOC_CLASSES = YES option. The option was imported from monolithic kdelibs 5 years ago and was not changed in kdelibs 4.x for 13 years. Looks like it was generated by Doxygen by default, at least I don't see any reason for this neither in comments nor in git history.

Is there any reason for hiding undocumented classes in open source code? Many  classes in frameworks does not have full documentation (KTcpSocket for example). It will not change any time soon. Such classes are not dead, they are used in many other places. Lack of any api doc even automatically generated one makes studying API much harder.

I think Doxyfile.global should include HIDE_UNDOC_CLASSES = NO or even EXTRACT_ALL = YES
Comment 1 Christoph Feck 2019-05-14 19:37:34 UTC 
*** Bug 217529 has been marked as a duplicate of this bug. ***