Differential D3439

Create a QCH file with the API dox, optionally, using ECMAddQCH
ClosedPublic
Actions

Authored by kossebau on Nov 21 2016, 6:52 PM.

Tags

Subscribers

Details

Reviewers

Group Reviewers

Commits

R288:66510d55dbe0: [FEATURE] Option to build & install QCH file with the public API dox

Summary

See https://phabricator.kde.org/D2854 for central discussion of new ECMAddQCH

Test Plan

KF5JobWidgets.qch created by this: https://share.kde.org/index.php/s/UhVPFAy2cTb8cBL

Diff Detail

Branch

addQCHBuild

Lint

No Linters Available

Unit

No Unit Test Coverage

kossebau updated this revision to Diff 8357.Nov 21 2016, 6:52 PM

kossebau retitled this revision from to Create a QCH file with the API dox, optionally, using ECMAddQCH.

kossebau updated this object.

kossebau edited the test plan for this revision. (Show Details)

kossebau added reviewers: Frameworks, ochurlaud.

shumski added a subscriber: shumski.Nov 21 2016, 8:53 PM

shumski added inline comments.

CMakeLists.txt
83	I wonder about the reasoning behind the existence of this export, and installation of it...
src/CMakeLists.txt
98	Is this really the right place?

kossebau added inline comments.Nov 21 2016, 9:01 PM

CMakeLists.txt
83	Imagine another project with a lib MyLib linking against KJobWidgets (in the public interface). For MyLib also a QCH file should be created. To create proper links from the QCH file for MyLib into the QCH file of KJobWidgets (via qthelp:// urls), doxygen/the qt tools need to have access to some information. This information is bound to the KF5JobWidgets_QCH target (see https://phabricator.kde.org/D2854). By exporting the target here and including it into KF5JobWidgetsConfig.cmake, this information then is automatically available to the ecm_add_qch call with MyLib and passing just the target name in the LINK_QCH argument.

shumski added inline comments.Nov 21 2016, 9:18 PM

CMakeLists.txt
83	Allright, make sense.

Use new KDE_INSTALL_FULL_QTQCHDIR

kossebau added a dependency: D2854: New: ECMAddQch, for generating qch & doxygen tag files.Nov 24 2016, 11:03 PM

update to latest version of proposed ECMAddQCH

update to latest ECMAddQch

Update to latest ECMAddQch

Restricted Application added a project: Frameworks. · View Herald TranscriptMay 18 2017, 1:35 PM

Closed by commit R288:66510d55dbe0: [FEATURE] Option to build & install QCH file with the public API dox (authored by kossebau). · Explain WhyJun 5 2017, 1:32 AM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			CMakeLists.txt (14 lines)
M			KF5JobWidgetsConfig.cmake.in (2 lines)
M			src/CMakeLists.txt (20 lines)

Diff 8589

CMakeLists.txt

Loading...

KF5JobWidgetsConfig.cmake.in

Loading...

src/CMakeLists.txt

Loading...