Added build for Doxygen docs

Build workflow will generate html files from source if Doxygen is present.
Signed-off-by: Tammy Leino <tammy_leino@mentor.com>
This commit is contained in:
Tammy Leino
2022-12-14 09:43:10 +01:00
committed by Arnaud Pouliquen
parent 081172c53c
commit c1f93a1b5d
22 changed files with 5181 additions and 0 deletions
+4
View File
@@ -35,3 +35,7 @@ add_subdirectory (lib)
if (WITH_APPS)
add_subdirectory (apps)
endif (WITH_APPS)
if (WITH_DOC)
add_subdirectory (doc)
endif (WITH_DOC)
+2769
View File
File diff suppressed because it is too large Load Diff
+4
View File
@@ -1,3 +1,7 @@
if (WITH_DOC)
find_package (Doxygen)
endif (WITH_DOC)
if (WITH_LIBMETAL_FIND)
find_package (Libmetal REQUIRED)
collect (PROJECT_INC_DIRS "${LIBMETAL_INCLUDE_DIR}")
+2
View File
@@ -114,4 +114,6 @@ if (DEFINED RPMSG_BUFFER_SIZE)
add_definitions( -DRPMSG_BUFFER_SIZE=${RPMSG_BUFFER_SIZE} )
endif (DEFINED RPMSG_BUFFER_SIZE)
option (WITH_DOC "Build with documentation" OFF)
message ("-- C_FLAGS : ${CMAKE_C_FLAGS}")
+17
View File
@@ -0,0 +1,17 @@
if (DOXYGEN_FOUND)
configure_file (Doxyfile.in Doxyfile @ONLY)
add_custom_target (doc ALL
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
install (DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
DESTINATION share/doc/${PROJECT_NAME})
install (FILES ${PROJECT_SOURCE_DIR}/README.md
DESTINATION share/doc/${PROJECT_NAME})
install (FILES ${PROJECT_SOURCE_DIR}/LICENSE.md
DESTINATION share/doc/${PROJECT_NAME})
endif (DOXYGEN_FOUND)
+2385
View File
File diff suppressed because it is too large Load Diff

Before

Width:  |  Height:  |  Size: 194 KiB

After

Width:  |  Height:  |  Size: 194 KiB

Before

Width:  |  Height:  |  Size: 171 KiB

After

Width:  |  Height:  |  Size: 171 KiB

Before

Width:  |  Height:  |  Size: 154 KiB

After

Width:  |  Height:  |  Size: 154 KiB

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 7.8 KiB