What is the procedure to generate documentation when CMake has been configured to generate build files for Visual Studio? It said that one should run make html_docs to build HTML-documentation. But there is not even a makefile. Also, is it a requirement to have doxygen installed to generate documentation? Or is Sphinx sufficient?
opencv moved to doxygen with opencv3, so you'll need that.
then it's quite easy:
make install (or build the INSTALL project in VS) will build the html docs in your install folder, you'll get exactly the same as here , the search feature works nicely, all you need then is a bookmark to /your/install/folder/docs/index.html in your browser.BUILD_DOCS is set, and output from CMake says Documentation: Doxygen: C:/Program Files/Doxygen/bin/doxygen.exe (ver 1.8.12) PlantUML: NO
But not 'docs' catalog is created in my_build/install folder when i run 'Build' on INSTALL in VS 2015. And when I open my_build/cmake_install.cmake then I see no trace of instructions to create any documentation. Is PlantUML required as well?
no, PlantUML is not required (it would just make nicer class hierarchy diagrams)
and sorry for typo, it's install/doc/html here (not docs)
but again, you have to explicitly build the INSTALL project on VS (right click, -> build) to make it happen, it's not part of the regular build-all routine.
Asked: 2016-10-13 07:35:38 -0600
Seen: 664 times
Last updated: Oct 13 '16
which opencv version is it ?
It's version 3.1.0
sphinx is only needed for opencv 2.4, you do not need it anymore for opencv 3