Merge pull request #1563 from jphickey/fix-1561-osal-apiguide

Fix #1561, use OSAL script to generate API guide
nasa · May 27, 2021 · d71583a · d71583a
2 parents 3fdecc6 + 2e0bc9f
commit d71583a
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 335 deletions.
diff --git a/cmake/Makefile.sample b/cmake/Makefile.sample
@@ -153,7 +153,6 @@ usersguide:
 
 osalguide:
 	$(MAKE) --no-print-directory -C "$(O)" osalguide
-	@/bin/echo -e "\n\nOsal Users Guide: \nfile://$(CURDIR)/$(O)/doc/osalguide/html/index.html\n"
 
 # 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_build.cmake b/cmake/mission_build.cmake
@@ -269,9 +269,6 @@ function(prepare)
   configure_file("${CFE_SOURCE_DIR}/cmake/cfe-common.doxyfile.in"
     "${CMAKE_BINARY_DIR}/doc/cfe-common.doxyfile")
 
-  configure_file("${CFE_SOURCE_DIR}/cmake/osal-common.doxyfile.in"
-    "${CMAKE_BINARY_DIR}/doc/osal-common.doxyfile")
-
   configure_file("${CFE_SOURCE_DIR}/cmake/mission-detaildesign.doxyfile.in"
     "${CMAKE_BINARY_DIR}/doc/mission-detaildesign.doxyfile")
 
@@ -298,18 +295,9 @@ function(prepare)
 
   string(REPLACE ";" " \\\n" MISSION_USERGUIDE_HEADERFILES "${MISSION_USERGUIDE_HEADERFILES}")
 
-  # OSAL API GUIDE include PUBLIC API
-  file(GLOB MISSION_OSAL_HEADERFILES
-    "${osal_MISSION_DIR}/src/os/inc/*.h"
-    "${CMAKE_BINARY_DIR}/doc/osconfig-example.h")
-  string(REPLACE ";" " \\\n" MISSION_OSAL_HEADERFILES "${MISSION_OSAL_HEADERFILES}")
-
   configure_file("${CFE_SOURCE_DIR}/cmake/cfe-usersguide.doxyfile.in"
     "${CMAKE_BINARY_DIR}/doc/cfe-usersguide.doxyfile")
 
-  configure_file("${CFE_SOURCE_DIR}/cmake/osalguide.doxyfile.in"
-    "${CMAKE_BINARY_DIR}/doc/osalguide.doxyfile")
-
   add_custom_target(mission-doc
     doxygen mission-detaildesign.doxyfile
     WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc")
@@ -318,9 +306,14 @@ function(prepare)
     doxygen cfe-usersguide.doxyfile
     WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc")
 
-  add_custom_target(osalguide
-    doxygen osalguide.doxyfile
-    WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc")
+  # OSAL API GUIDE include PUBLIC API
+  set(OSAL_API_INCLUDE_DIRECTORIES
+    "${osal_MISSION_DIR}/src/os/inc"
+    "${CMAKE_BINARY_DIR}/doc"
+  )
+  add_subdirectory(${osal_MISSION_DIR}/doc/src ${CMAKE_BINARY_DIR}/doc/osalguide)
+  add_custom_target(osalguide)
+  add_dependencies(osalguide osal-apiguide)
 
   # Pull in any application-specific mission-scope configuration
   # This may include user configuration files such as cfe_mission_cfg.h,

diff --git a/cmake/osal-common.doxyfile.in b/cmake/osal-common.doxyfile.in
diff --git a/cmake/osalguide.doxyfile.in b/cmake/osalguide.doxyfile.in
diff --git a/docs/src/osal_fs.dox b/docs/src/osal_fs.dox
diff --git a/docs/src/osal_timer.dox b/docs/src/osal_timer.dox
diff --git a/docs/src/osalmain.dox b/docs/src/osalmain.dox