Fix nasa#2083, Consistent doxygen flow/naming for generation

skliper · Apr 11, 2022 · 9722771 · 9722771
1 parent a6c6b65
commit 9722771
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 18 deletions.
diff --git a/cmake/Makefile.sample b/cmake/Makefile.sample
@@ -145,14 +145,12 @@ lcov:
 
 doc:
  $(MAKE) --no-print-directory -C "$(O)" mission-doc
- @/bin/echo -e "\n\nDetail Design: \nfile:https://$(CURDIR)/$(O)/docs/detaildesign/html/index.html\n"
 
 usersguide:
  $(MAKE) --no-print-directory -C "$(O)" cfe-usersguide
- @/bin/echo -e "\n\ncFE Users Guide: \nfile:https://$(CURDIR)/$(O)/docs/users_guide/html/index.html\n"
 
 osalguide:
- $(MAKE) --no-print-directory -C "$(O)" osalguide
+ $(MAKE) --no-print-directory -C "$(O)" osal-apiguide
 
 # Make all the commands that use the build tree depend on a flag file
 # that is used to indicate the prep step has been done. This way

diff --git a/cmake/mission-detaildesign.doxyfile.in → cmake/mission-doc.doxyfile.in b/cmake/mission-detaildesign.doxyfile.in → cmake/mission-doc.doxyfile.in
@@ -8,11 +8,11 @@
 # Common configuration and default settings
 @INCLUDE = @MISSION_BINARY_DIR@/docs/cfe-common.doxyfile
 
-# Example detailed design setup
+# Example mission doc design setup
 PROJECT_NAME = "@MISSION_NAME@"
 PROJECT_BRIEF = "Core Flight System project built using \"@MISSIONCONFIG@\" configuration"
-OUTPUT_DIRECTORY = @CMAKE_BINARY_DIR@/docs/detaildesign
-WARN_LOGFILE = @CMAKE_BINARY_DIR@/docs/detaildesign-warnings.log
+OUTPUT_DIRECTORY = @CMAKE_BINARY_DIR@/docs/mission-doc
+WARN_LOGFILE = mission-doc-warnings.log
 
 # Include mission defs directory
 INPUT += @MISSION_DEFS@

diff --git a/cmake/mission_build.cmake b/cmake/mission_build.cmake
@@ -305,30 +305,28 @@ function(prepare)
  "${CMAKE_BINARY_DIR}/docs/cfe-common.doxyfile"
  @ONLY)
 
- file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/docs/detaildesign")
- configure_file("${CFE_SOURCE_DIR}/cmake/mission-detaildesign.doxyfile.in"
- "${CMAKE_BINARY_DIR}/docs/detaildesign/Doxyfile"
+ file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/docs/mission-doc")
+ configure_file("${CFE_SOURCE_DIR}/cmake/mission-doc.doxyfile.in"
+ "${CMAKE_BINARY_DIR}/docs/mission-doc/Doxyfile"
  @ONLY)
  add_custom_target(mission-doc doxygen
- COMMAND echo "Detail Design: file:https://${CMAKE_BINARY_DIR}/docs/detaildesign/html/index.html"
- WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/docs/detaildesign")
+ COMMAND echo "Detail Design: file:https://${CMAKE_BINARY_DIR}/docs/mission-doc/html/index.html"
+ WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/docs/mission-doc")
 
- file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/docs/users_guide")
+ file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/docs/cfe-usersguide")
  configure_file("${CFE_SOURCE_DIR}/cmake/cfe-usersguide.doxyfile.in"
- "${CMAKE_BINARY_DIR}/docs/users_guide/Doxyfile"
+ "${CMAKE_BINARY_DIR}/docs/cfe-usersguide/Doxyfile"
  @ONLY)
  add_custom_target(cfe-usersguide doxygen
- COMMAND echo "Users Guide: file:https://${CMAKE_BINARY_DIR}/docs/users_guide/html/index.html"
- WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/docs/users_guide")
+ COMMAND echo "Users Guide: file:https://${CMAKE_BINARY_DIR}/docs/cfe-usersguide/html/index.html"
+ WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/docs/cfe-usersguide")
 
  # OSAL API GUIDE include PUBLIC API
  set(OSAL_API_INCLUDE_DIRECTORIES
  "${osal_MISSION_DIR}/src/os/inc"
  "${CMAKE_BINARY_DIR}/docs"
  )
- add_subdirectory(${osal_MISSION_DIR}/docs/src ${CMAKE_BINARY_DIR}/docs/osalguide)
- add_custom_target(osalguide)
- add_dependencies(osalguide osal-apiguide)
+ add_subdirectory(${osal_MISSION_DIR}/docs/src ${CMAKE_BINARY_DIR}/docs/osal-apiguide)
 
  # Pull in any application-specific mission-scope configuration
  # This may include user configuration files such as cfe_mission_cfg.h,