Skip to content

Commit

Permalink
Added CMake target for Doxy documentation.
Browse files Browse the repository at this point in the history
Change-Id: I4c8b55d7add763d37a67e24d7bfa0d4f28a3f6a3
  • Loading branch information
Ionel Gog committed Oct 24, 2016
1 parent 2e03049 commit ee58844
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
3 changes: 3 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ include(LintTargets)
# Docker target (image build)
include(DockerTargets)

# Doxy documentaion target
include(DoxyTargets)

# Unit tests
if (BUILD_TESTS)
enable_testing()
Expand Down
3 changes: 0 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,3 @@ all:
@echo " $$ cd build"
@echo " $$ make"
@echo "-----------------------------------------------"

doc:
doxygen Doxyfile
3 changes: 3 additions & 0 deletions cmake/DoxyTargets.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_custom_target(doxy-doc
COMMAND ${Firmament_ROOT_DIR}/contrib/generate-documentation.sh ${Firmament_ROOT_DIR}
COMMENT "Generating Doxy documentation...")
5 changes: 5 additions & 0 deletions contrib/generate-documentation.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/bin/bash
# $1 = Firmament root dir

cd $1
doxygen Doxyfile

0 comments on commit ee58844

Please sign in to comment.