Converts Doxygen Documentation to a Dash or Zeal Docset.
Requirements: A C++ 14 compiler and CMake.
git submodule update --init --recursive
cmake -B build
cmake --build build
./build/source/doxygen2docset
../build/tests/doxygen2docset_unittests
.Doxyfile
for your project, make sure the following options are set:
GENERATE_DOCSET = YES
GENERATE_HTML = YES
doxygen
to generate HTML documentation. On a successful invocationTokens.xml
Info.plist
Generate the Docset from the Doxygen generated docs using:
doxgen2docset --doxygen <path to doxygen source> --docset <path to docset dir> [--help]
--doxygen Required: The path the HTML sources generated by Doxygen,
see the explanatory section below on how to configure Doxygen.
--docset Required: The path to the directory where this tool will
generate the docset. The name of the docset will be derived
from the Docset bundle identifier. For example, if the
Docset bundle identifer is, "com.exmple.docs", a docset
named "com.exmple.docs.docset" will be generated in this
directory.
To configure the docset bundle identifier, set the
DOCSET_BUNDLE_ID property in your Doxyfile before generating
documentation.
--help Print this documentation.