Kapidox generates qch files
ClosedPublic

Authored by ochurlaud on Apr 2 2017, 11:55 AM.

Details

Summary

Hey guys,

could you check if the qch generation is usable for you please?

for this, please run

path/to/kapidox/src/kapidox_generate path/to/your/source/files --qhp

And chech in the qch/ folder that it suits you.

(The code will need refactoring, but first I want to be sure it does something good)

Diff Detail

Repository
R264 KApiDox
Branch
olivier/do_qch
Lint
No Linters Available
Unit
No Unit Test Coverage
ochurlaud created this revision.Apr 2 2017, 11:55 AM
Restricted Application added projects: Frameworks, Documentation. · View Herald TranscriptApr 2 2017, 11:55 AM
Restricted Application added subscribers: Documentation, Frameworks. · View Herald Transcript
ochurlaud edited the summary of this revision. (Show Details)Apr 2 2017, 11:58 AM
ochurlaud added reviewers: kossebau, KDevelop.

I add some people who may be able to tell me if the output can be used in the kdevelop generation (because I heard you use it).

I don't use qch files myself, so I need an external view

apol edited edge metadata.Apr 3 2017, 1:14 PM

Having qch files should work, yes. If you can generate one, we can easily check if it works in KDevelop...

ochurlaud added a comment.EditedApr 3 2017, 8:28 PM

Here 3 examples. Frameworks only contains KApiDox, KConfigWidgets and KItemModels. I could have generated all of them of course...

There is one known issue: the hyperlinks sometimes point to a web page (for Qt keywords).

ochurlaud updated this revision to Diff 13076.Apr 3 2017, 9:00 PM
ochurlaud edited the summary of this revision. (Show Details)

Update: Order alphabetically the libs in a product

Hi, Olivier.

Your QCH files displayed normally but with one bug - broken links for some JavaScript code. For example open KTipDialog class doc from your Frameworks file. Then try to click (open) Public Member Functions inherited from QDialog - nothing happens :( See QCH file from D3261 - for KAutoSaveFile class for example such actions works well.

ochurlaud updated this revision to Diff 13209.Apr 7 2017, 8:00 PM

Corrected antonanikin issue

Hi, Olivier.

Your QCH files displayed normally but with one bug - broken links for some JavaScript code. For example open KTipDialog class doc from your Frameworks file. Then try to click (open) Public Member Functions inherited from QDialog - nothing happens :( See QCH file from D3261 - for KAutoSaveFile class for example such actions works well.

Could you check now?
@apol Can the Kdevelop team use what I produced or not?

Thx

Corrected antonanikin issue

Olivier, thanks for fixing - now such collapsable lists works good.

This revision was automatically updated to reflect the committed changes.