Skip to content

Commit 7b6d630

Browse files
committed
Add doxygen auto generation.
Issue #20
1 parent 6e7f74d commit 7b6d630

File tree

9 files changed

+2654
-5
lines changed

9 files changed

+2654
-5
lines changed

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,9 @@
3131
*.out
3232
*.app
3333

34+
# Doxygen
35+
*.bak
36+
3437
# Directory
35-
build/
38+
build/
39+
html/

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
66

77
## [Unreleased] - YYYY-MM-DD
88
### Added
9+
- [Issue #20](https://github.com/suikan4github/template_application/issues/20) : Add doxygen auto generation.
10+
911
### Changed
1012
### Fixed
1113

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,5 @@ include("CPack")
4545
# Subdirectories
4646
add_subdirectory("src")
4747
add_subdirectory("test")
48-
48+
add_subdirectory("doc")
4949

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ ctest
8585
Run followings on the shell.
8686
```Shell
8787
sudo snap install code --classic
88-
sudo apt-get install build-essential cmake
88+
sudo apt-get install build-essential cmake doxygen
8989
```
9090
- Note 1: After installing VS CODE, install the [C++ Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack) and the [Gcov Viewer extension](https://marketplace.visualstudio.com/items?itemName=JacquesLucke.gcov-viewer) to the VS CODE.
9191
### Windows
@@ -97,6 +97,7 @@ winget install Kitware.CMake -e
9797
winget install Microsoft.VisualStudio.2022.Community -e
9898
winget install Git.Git -e
9999
winget install Python.Python.3 -e
100+
winget install doxygen -e
100101
```
101102
- Note 1: After installing VS CODE, install the [C++ Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack) and the [Gcov Viewer extension](https://marketplace.visualstudio.com/items?itemName=JacquesLucke.gcov-viewer) to the VS CODE.
102103
- Note 2: The above winget install the CMake installer only. Run the CMake once and complete the installation.
@@ -112,7 +113,7 @@ winget install Microsoft.VisualStudioCode -e
112113
```
113114
Then, run followings on the Ubuntu shell.
114115
```Shell
115-
sudo apt-get install build-essential cmake ca-certificates
116+
sudo apt-get install build-essential cmake doxygen ca-certificates
116117
```
117118
- Note 1: After installing VS CODE, install the [C++ Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack) and the [Gcov Viewer extension](https://marketplace.visualstudio.com/items?itemName=JacquesLucke.gcov-viewer) to the VS CODE.
118119

doc/CMakeLists.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Search for Doxygen package. The result is stored to DOXYGEN_FOUND variable
2+
find_package(Doxygen)
3+
4+
# Is Doxygen found?
5+
if(${DOXYGEN_FOUND})
6+
7+
# Declaration of doxygen command execution
8+
add_custom_target(documents ALL
9+
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
10+
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile
11+
)
12+
13+
else(${DOXYGEN_FOUND})
14+
# Not found
15+
message(WARNING "Doxygen package is not found.")
16+
endif(${DOXYGEN_FOUND})

0 commit comments

Comments
 (0)