search

fktn-k / fkYAML

A C++ header-only YAML library
MIT License
69 stars 7 forks source link

#10 support doxygen #12

Closed fktn-k closed 1 year ago

fktn-k commented 1 year ago

Support for Doxygen has been added to this project.
To enable generating API documents with Doxygen, execute the folowing command: 

$ cd path/to/repo
$ mkdir build && cd build
$ cmake .. -DFK_YAML_RUN_DOXYGEN
$ cmake --build . --config Release --target doxygen

After executing the above commands, the API documentation will be generated under repo-root/build/doxygen directory.
To check the contents, double-click html/index.html file and open it on your browser.

Currently, the above process is not executed on GitHub Actions in any case, and I'm not sure if it has to be included or not. (So, it may or may not be included in GitHub Actions in the future.)

close #10