diff --git a/CMakeLists.txt b/CMakeLists.txt index 178adff9..51f8f7bb 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -56,7 +56,8 @@ ENDIF() MESSAGE(STATUS "") MESSAGE(STATUS "Summary") MESSAGE(STATUS "-------") -MESSAGE(STATUS "Build examples: " ${ENABLE_EXAMPLES}) -MESSAGE(STATUS "Build tests: " ${BUILD_TESTING}) -MESSAGE(STATUS "API Docs available: " ${BUILD_DOCS}) +MESSAGE(STATUS "Build examples: " ${ENABLE_EXAMPLES}) +MESSAGE(STATUS "Build tests: " ${BUILD_TESTING}) +MESSAGE(STATUS "API Docs available: " ${DOXYGEN_FOUND}) +MESSAGE(STATUS " - Qt Help bundling: " ${BUILD_DOCS}) MESSAGE(STATUS "") diff --git a/INSTALL.txt b/INSTALL.txt index 0c0d0f4d..b4c718fa 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -13,7 +13,7 @@ To build PolyVox you need: With the following options: * `Qt `_ for building the tests - * ``qcollectiongenerator`` which comes with Qt Assistant is required for bundling the docs for installation + * ``qcollectiongenerator`` which comes with Qt Assistant is used for bundling the docs for installation * `Doxygen `_ for building the documentation Linux @@ -78,13 +78,13 @@ To run the tests you do not need to have run ``make install``. Simply run:: API Documentation ----------------- -If you want to generate the API documentation, you'll need Doxygen and ``qcollectiongenerator`` installed. If you saw ``API Docs available: YES`` at the end of the CMake output then you're all set. To generate the docs, just run:: +If you want to generate the API documentation, you'll need Doxygen installed. If you saw ``API Docs available: YES`` at the end of the CMake output then you're all set. To generate the docs, just run:: make doc and the documentation can be browsed in plain HTML form at ``/library/doc/html/index.html``. -On top of this, PolyVox will also compile and install this documentation as a *Qt Help Collection* file to ``/share/doc/packages/polyvox/qthelp/polyvox.qhc`` (this file is in the build directory as ``/library/doc/html/polyvox.qhc``). To view this file you need Qt Assistant installed. You can open it with:: +On top of this, if ``qcollectiongenerator`` is installed, PolyVox can also compile and install this documentation as a *Qt Help Collection* file to ``/share/doc/packages/polyvox/qthelp/polyvox.qhc`` (this file is in the build directory as ``/library/doc/html/polyvox.qhc``). To view this file you need Qt Assistant installed. You can open it with:: assistant -collectionFile library/doc/html/polyvox.qhc diff --git a/library/CMakeLists.txt b/library/CMakeLists.txt index b4b98090..e3aab9e6 100644 --- a/library/CMakeLists.txt +++ b/library/CMakeLists.txt @@ -41,7 +41,7 @@ if(DOXYGEN_FOUND) if(QT_QCOLLECTIONGENERATOR_EXECUTABLE) configure_file(${CMAKE_CURRENT_SOURCE_DIR}/polyvox.qhcp.in ${CMAKE_CURRENT_BINARY_DIR}/doc/html/polyvox.qhcp) #The QtHelp config file - #We attach this command to the doc target wo it will be run automatically + #We attach this command to the doc target so it will be run automatically add_custom_command(TARGET doc POST_BUILD COMMAND ${QT_QCOLLECTIONGENERATOR_EXECUTABLE} polyvox.qhcp -o polyvox.qhc WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc/html