Fix #2083, Consistent doxygen flow/naming for generation

nasa · Apr 11, 2022 · 58a8780 · 58a8780
1 parent a6c6b65
commit 58a8780
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 20 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://$(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://$(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/cfe-usersguide.doxyfile.in b/cmake/cfe-usersguide.doxyfile.in
@@ -13,8 +13,8 @@
 
 # Document specific settings
 PROJECT_NAME           = "Core Flight Executive Users Guide"
-OUTPUT_DIRECTORY       = @CMAKE_BINARY_DIR@/docs/users_guide
-WARN_LOGFILE           = @CMAKE_BINARY_DIR@/docs/users_guide/cfe-usersguide-warnings.log
+OUTPUT_DIRECTORY       = @CMAKE_BINARY_DIR@/docs/cfe-usersguide
+WARN_LOGFILE           = cfe-usersguide-warnings.log
 
 # For purposes of the user guide, reference the "stock" mission configuration
 # Although missions may override these files, for the users guide we are mainly

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://${CMAKE_BINARY_DIR}/docs/detaildesign/html/index.html"
-    WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/docs/detaildesign")
+    COMMAND echo "Detail Design: file://${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://${CMAKE_BINARY_DIR}/docs/users_guide/html/index.html"
-    WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/docs/users_guide")
+    COMMAND echo "Users Guide: file://${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,