The way to add a new help file (say .qch file) in Qt Creator is every time the same:<\/p>\n
- \n
- Get the desired qch file<\/li>\n
- in QtCreator go in Tools –> options –> Help. The documentation tab and clic “add”, then select your .qch file.<\/li>\n
- restart QtCreator<\/li>\n<\/ol>\n
On the previous link you can found many ressources about classical libraries. Here is my own selection (the qch file are linked):<\/p>\n
- \n
- C++<\/a> (25.5 Mo)<\/li>\n
- ITK 4 6 0<\/a>\u00a0 (810.6 Mo<\/strong>)<\/li>\n<\/ul>\n
<\/p>\n
![\"Configuring](\"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/wp-content\/uploads\/TaT\/qch\/QtCreator_HelpConf.PNG\" "\\"Configuring")
<\/p>\n<\/p>\n
In order to generate new qch files, Doxygen is able to produce QHP files. Then there is a tool from Qt that produces the QCH file from QHP. If well configured, doxygen can produce a .qch file. remind to set properly these flags:<\/p>\n
- \n
- GENERATE_QHP = YES\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 (produce QHP file)<\/li>\n
- QCH_FILE\u00a0 = TheFile.qch\u00a0\u00a0\u00a0\u00a0 (as said in the help file : you have to specify QHG_LOCATIION)<\/li>\n
- QHP_NAMESPACE = The.Lib.name<\/li>\n
- QHG_LOCATION\u00a0 =\u00a0 \/bin\/qhelpgenerator\u00a0\u00a0\u00a0\u00a0 (or qhelpgenerator … the tool to go from qhp to qch)<\/li>\n<\/ul>\n
As example for ITK, CMake allow us to build documentation using doxygen and produces the doxygen.config file:<\/p>\n
- \n
- set the flag “BUILD_DOCUMENTATION” to ON (in the advanced mode), then configure.<\/li>\n
- then, set also to ON the flag “ITK_DOXYGEN_QHP”.<\/li>\n
- configure and generate,<\/li>\n
- then “make -j8” (and remind that the documentation generation tools is very very long).<\/li>\n<\/ol>\n
These steps should produce an “index.qhp” file (close to “.\/Utilities\/Doxygen\/html\/index.qhp” in your building directory) as\u00a0 ITK don’t complete properly QHP_NAMESPACE and\u00a0QHG_LOCATION (but you can edit the doxygen.config.in before all…). So, in order to convert your QHP file into a qch file, execute qhelpgenerator manually: qhelpgenerator index.qhp -o ~\/ITK.qch<\/em><\/p>\n
Done!<\/p>\n
![\"Qt](\"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/wp-content\/uploads\/TaT\/qch\/QT_Cpp.PNG\" "\\"Qt")
<\/p>\n<\/p>\n
![\"\"](\"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/wp-content\/uploads\/TaT\/qch\/QT_ITK.PNG\" "\\"QtCreator")
QtCreator with ITK Documentation<\/figcaption><\/figure>\n <\/p>\n","protected":false},"excerpt":{"rendered":"
In QtCreator, when pressing “F1” while editing your code you can get help on the selected word. Natively, this is working well for Qt classes, but not for std::vector nor itk::Image and so on… In fact it is possible to add dedicated help file to QtCreator: see here. The way to add a new help […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[13],"tags":[],"class_list":["post-273","post","type-post","status-publish","format-standard","hentry","category-tips-and-tricks"],"_links":{"self":[{"href":"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/index.php?rest_route=\/wp\/v2\/posts\/273","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=273"}],"version-history":[{"count":9,"href":"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/index.php?rest_route=\/wp\/v2\/posts\/273\/revisions"}],"predecessor-version":[{"id":276,"href":"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/index.php?rest_route=\/wp\/v2\/posts\/273\/revisions\/276"}],"wp:attachment":[{"href":"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=273"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=273"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.creatis.insa-lyon.fr\/~grenier\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=273"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
- ITK 4 6 0<\/a>\u00a0 (810.6 Mo<\/strong>)<\/li>\n<\/ul>\n
- C++<\/a> (25.5 Mo)<\/li>\n