mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-01 00:46:20 -05:00
45f0cff256
This adds a new cmake option GENERATE_QHP. If the api docs are set to being built (ie doxygen is available and WITH_APIDOC is true) then setting GENERATE_QHP to true will cause doxygen to create a compiled Qt help file from the QGIS docs. This QHP file can then be used by QtCreator to show the QGIS api directly within the QtCreator help (ie, press F1 on a class or member to see the docs). To do this, you need to: - make sure doxygen is installed, WITH_APIDOC is true and GENERATE_QHP is true - build to generate the docs - In QtCreator, go to Tools -> Options -> Help, switch to the "Documentation" tab and click "Add". Point it to your generate QHP file (should be in the build folder doc\api\qch folder) - Restart QtCreator, wait a bit, and then you should have the api docs available under the "Help" tab and by pressing F1 on a QGIS class/method
