Bug 441946

Summary:	1.0.0: no qcm devel documentation
Product:	[Frameworks and Libraries] frameworks-kuserfeedback	Reporter:	kloczek <kloczko.tomasz>
Component:	Management and Analytics Console	Assignee:	Volker Krause <vkrause>
Status:	REPORTED ---
Severity:	normal
Priority:	NOR
Version First Reported In:	unspecified
Target Milestone:	---
Platform:	Other
OS:	Other
Latest Commit:		Version Fixed/Implemented In:
Sentry Crash Report:

Description kloczek 2021-09-03 10:18:25 UTC

I think that ift would be good to add handle cmake BUILD_QCH=ON to be able generate library documentation.

Comment 1 kloczek 2021-09-03 10:29:19 UTC

Sorry I was a bit wrong .. a bit because only install path is icorrect.
Here is the patch which fixes install path

--- a/docs/CMakeLists.txt~      2021-09-03 11:25:50.313318076 +0100
+++ b/docs/CMakeLists.txt       2021-09-03 11:25:52.700321367 +0100
@@ -47,7 +47,7 @@
     DEPENDS ${_qdoc_output_dir}/user-feedback-manual.qhp
 )
 add_custom_target(user_feedback_manual_qch ALL DEPENDS ${_qdoc_output_dir}/user-feedback-manual.qch)
-install(FILES ${_qdoc_output_dir}/user-feedback-manual.qch DESTINATION ${KDE_INSTALL_DATAROOTDIR}/KDE/UserFeedbackConsole)
+install(FILES ${_qdoc_output_dir}/user-feedback-manual.qch DESTINATION ${KDE_INSTALL_QTQCHDIR})

 # build .qhc
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/user-feedback.qhcp.in ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhcp)
@@ -61,4 +61,4 @@
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
 )
 add_custom_target(user_feedback_qhc ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhc)
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhc DESTINATION ${KDE_INSTALL_DATAROOTDIR}/KDE/UserFeedbackConsole)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhc DESTINATION ${KDE_INSTALL_QTQCHDIR})

Comment 2 kloczek 2021-09-03 10:48:34 UTC

Loooks like as well output file name is wrong

--- a/docs/CMakeLists.txt~      2020-02-05 14:04:50.000000000 +0000
+++ b/docs/CMakeLists.txt       2021-09-03 11:46:29.155042277 +0100
@@ -47,18 +47,18 @@
     DEPENDS ${_qdoc_output_dir}/user-feedback-manual.qhp
 )
 add_custom_target(user_feedback_manual_qch ALL DEPENDS ${_qdoc_output_dir}/user-feedback-manual.qch)
-install(FILES ${_qdoc_output_dir}/user-feedback-manual.qch DESTINATION ${KDE_INSTALL_DATAROOTDIR}/KDE/UserFeedbackConsole)
+install(FILES ${_qdoc_output_dir}/user-feedback-manual.qch DESTINATION ${KDE_INSTALL_QTQCHDIR})

 # build .qhc
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/user-feedback.qhcp.in ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhcp)
 add_custom_command(
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhc
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qch
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_BINARY_DIR}/manual/user-feedback-manual.qch ${CMAKE_CURRENT_BINARY_DIR}
-    COMMAND Qt5::qcollectiongenerator ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhcp -o ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhc
+    COMMAND Qt5::qcollectiongenerator ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhcp -o ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qch
     DEPENDS
         ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhcp
         user_feedback_manual_qch
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
 )
 add_custom_target(user_feedback_qhc ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhc)
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhc DESTINATION ${KDE_INSTALL_DATAROOTDIR}/KDE/UserFeedbackConsole)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qch DESTINATION ${KDE_INSTALL_QTQCHDIR})


And there is no as wll *tags files

Comment 3 kloczek 2021-09-03 10:52:05 UTC

corrected:

--- a/docs/CMakeLists.txt~      2020-02-05 14:04:50.000000000 +0000
+++ b/docs/CMakeLists.txt       2021-09-03 11:50:31.122389282 +0100
@@ -47,18 +47,18 @@
     DEPENDS ${_qdoc_output_dir}/user-feedback-manual.qhp
 )
 add_custom_target(user_feedback_manual_qch ALL DEPENDS ${_qdoc_output_dir}/user-feedback-manual.qch)
-install(FILES ${_qdoc_output_dir}/user-feedback-manual.qch DESTINATION ${KDE_INSTALL_DATAROOTDIR}/KDE/UserFeedbackConsole)
+install(FILES ${_qdoc_output_dir}/user-feedback-manual.qch DESTINATION ${KDE_INSTALL_QTQCHDIR})

 # build .qhc
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/user-feedback.qhcp.in ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhcp)
 add_custom_command(
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhc
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qch
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_BINARY_DIR}/manual/user-feedback-manual.qch ${CMAKE_CURRENT_BINARY_DIR}
-    COMMAND Qt5::qcollectiongenerator ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhcp -o ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhc
+    COMMAND Qt5::qcollectiongenerator ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhcp -o ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qch
     DEPENDS
         ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhcp
         user_feedback_manual_qch
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
 )
-add_custom_target(user_feedback_qhc ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhc)
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qhc DESTINATION ${KDE_INSTALL_DATAROOTDIR}/KDE/UserFeedbackConsole)
+add_custom_target(user_feedback_qch ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qch)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/user-feedback.qch DESTINATION ${KDE_INSTALL_QTQCHDIR})