AnotherFoxGuy/polyvox
1
0
Fork 0
Code Issues Pull Requests Activity

Fix up the docs to reflect the latest changes.

Browse Source
This commit is contained in:
Matt Williams 2010-07-02 11:00:49 +00:00
parent 0f786ede64
commit e470fc6b2e
3 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CMakeLists.txt
View File

@ -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 "")

6
INSTALL.txt
View File

@ -13,7 +13,7 @@ To build PolyVox you need:
With the following options:
* `Qt <http://qt.nokia.com>`_ 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 <http://doxygen.org>`_ 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 ``<build directory>/library/doc/html/index.html``.
On top of this, PolyVox will also compile and install this documentation as a *Qt Help Collection* file to ``<prefix>/share/doc/packages/polyvox/qthelp/polyvox.qhc`` (this file is in the build directory as ``<build directory>/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 ``<prefix>/share/doc/packages/polyvox/qthelp/polyvox.qhc`` (this file is in the build directory as ``<build directory>/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

2
library/CMakeLists.txt
View File

@ -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