Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modern documentation #525

Merged
merged 5 commits into from
May 3, 2024
Merged

Modern documentation #525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dfae5f3
Added initial support for building doxygen-awesome documentation
githubuser0xFFFF May 3, 2024
b86d2db
Updated brief description for doxygen awesome style
githubuser0xFFFF May 3, 2024
5f00604
Updated coin.doxygen.awesome.cmake.in to latest doxygen version 1.10
githubuser0xFFFF May 3, 2024
e75c94c
Activated sorting of member functions for doxygen-awesome
githubuser0xFFFF May 3, 2024
396b532
Stripped comments from docs/coin.doxygen.awesome.cmake.in
githubuser0xFFFF May 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@
[submodule "cpack.d"]
path = cpack.d
url = https://github.com/coin3d/cpack.d
[submodule "docs/doxygen-awesome"]
path = docs/doxygen-awesome
url = https://github.com/coin3d/doxygen-awesome-css.git
branch = coin3d
2 changes: 2 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ include(CoinCMakeUtilities)
option(COIN_BUILD_SHARED_LIBS "Build shared library when ON (default), static when OFF." ON)
option(COIN_BUILD_TESTS "Build unit tests when ON (default), skips them when OFF." ON)
option(COIN_BUILD_DOCUMENTATION "Build and install API documentation (requires Doxygen)." OFF)
option(COIN_BUILD_AWESOME_DOCUMENTATION "Build and install API documentation in new modern style (requires Doxygen)." OFF)
cmake_dependent_option(COIN_BUILD_INTERNAL_DOCUMENTATION "Document internal code not part of the API." OFF "COIN_BUILD_DOCUMENTATION" OFF)
cmake_dependent_option(COIN_BUILD_DOCUMENTATION_MAN "Build Coin man pages." OFF "COIN_BUILD_DOCUMENTATION" OFF)
cmake_dependent_option(COIN_BUILD_DOCUMENTATION_QTHELP "Build QtHelp documentation." OFF "COIN_BUILD_DOCUMENTATION" OFF)
Expand Down Expand Up @@ -113,6 +114,7 @@ report_prepare(
COIN_BUILD_DOCUMENTATION_MAN
COIN_BUILD_DOCUMENTATION_QTHELP
COIN_BUILD_DOCUMENTATION_CHM
COIN_BUILD_AWESOME_DOCUMENTATION
COIN_THREADSAFE
HAVE_VRML97
COIN_HAVE_JAVASCRIPT
Expand Down
Loading
Loading