Robin Mueller
c2bf09d506
This PR introduces the generation of documentation based on this excellent blog post: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/ It combines the tools Sphinx, Doxygen and Breathe to generate good looking HTML documentation conveniently which can be hosted easily. The helper scripts were unified and there is now one helper.py script which can be used to create, build and open both tests and documentation. "./helper.py -h" can be used to get the different options. This PR also contains some smaller fixes which were necessary for the docs to build
50 lines
1.5 KiB
CMake
50 lines
1.5 KiB
CMake
if(DEFINED TARGET_NAME)
|
|
target_include_directories(${TARGET_NAME} PRIVATE
|
|
${CMAKE_CURRENT_SOURCE_DIR}
|
|
)
|
|
|
|
target_sources(${TARGET_NAME} PRIVATE
|
|
ipc/missionMessageTypes.cpp
|
|
pollingsequence/PollingSequenceFactory.cpp
|
|
objects/FsfwFactory.cpp
|
|
)
|
|
|
|
# If a special translation file for object IDs exists, compile it.
|
|
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/objects/translateObjects.cpp")
|
|
target_sources(${TARGET_NAME} PRIVATE
|
|
objects/translateObjects.cpp
|
|
)
|
|
endif()
|
|
|
|
# If a special translation file for events exists, compile it.
|
|
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/objects/translateObjects.cpp")
|
|
target_sources(${TARGET_NAME} PRIVATE
|
|
events/translateEvents.cpp
|
|
)
|
|
endif()
|
|
else()
|
|
target_include_directories(${LIB_FSFW_NAME} PRIVATE
|
|
${CMAKE_CURRENT_SOURCE_DIR}
|
|
)
|
|
|
|
target_sources(${LIB_FSFW_NAME} PRIVATE
|
|
ipc/missionMessageTypes.cpp
|
|
pollingsequence/PollingSequenceFactory.cpp
|
|
objects/FsfwFactory.cpp
|
|
)
|
|
|
|
# If a special translation file for object IDs exists, compile it.
|
|
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/objects/translateObjects.cpp")
|
|
target_sources(${LIB_FSFW_NAME} PRIVATE
|
|
objects/translateObjects.cpp
|
|
)
|
|
endif()
|
|
|
|
# If a special translation file for events exists, compile it.
|
|
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/objects/translateObjects.cpp")
|
|
target_sources(${LIB_FSFW_NAME} PRIVATE
|
|
events/translateEvents.cpp
|
|
)
|
|
endif()
|
|
endif()
|