Fix nasa#559, update comments to fix doxygen warnings (WIP)

lbleier-GSFC · Apr 27, 2020 · 3824894 · 3824894
1 parent 5044b44
commit 3824894
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 8 deletions.
diff --git a/docs/src/cfe_es.dox b/docs/src/cfe_es.dox
@@ -69,7 +69,7 @@
 
   <CENTER><B>Application</B></CENTER>
 
-  The term 'Application' as defined in the \ref cfeglossary is <i> a set of
+  The term 'Application' as defined in the main.dox::cfeglossary is <i> a set of
   data and functions that is treated as a single entity by the cFE.  cFE
   resources are allocated on a per-Application basis.  Applications are made up
   of a Main Task and zero or more Child Tasks.</i>
@@ -849,4 +849,3 @@
   The following are configuration parameters used to configure the cFE Executive Services
   either for each platform or for a mission as a whole.
 **/
-
diff --git a/docs/src/cfe_sb.dox b/docs/src/cfe_sb.dox
@@ -6,8 +6,7 @@
   by sending command and telemetry messages.  The software bus provides an application
   programming interface (API) to other tasks for sending and receiving messages.
   This API is independent of the underlying operating system so that tasks can use
-  the same interface regardless of which processor they reside on.  Refer to the
-  \ref cfeapi for detailed information about the API functions.
+  the same interface regardless of which processor they reside on.  Refer to the main.dox::cfeapi for detailed information about the API functions.
 
   The software bus is used internally by the flight software, and normally does not
   require attention from the ground.  However, because of the scalability and the
@@ -533,7 +532,7 @@
            can get confusing. How can I be sure that the correct address is given for this
            parameter.
         </B><TR><TD WIDTH="5%"> &nbsp; <TD WIDTH="95%">
-           Typically a caller declares a ptr of type #CFE_SB_Msg_t  (i.e. CFE_SB_Msg_t *Ptr)
+           Typically a caller declares a ptr of type cfe_sb.h::CFE_SB_Msg_t  (i.e. CFE_SB_Msg_t *Ptr)
            then gives the address of that pointer (&Ptr) as this parameter. After a successful
            call to #CFE_SB_RcvMsg, Ptr will point to the first byte of the software bus message
            header. This should be used as a read-only pointer. In systems with an MMU, writes
@@ -602,4 +601,3 @@
 **  The following are configuration parameters used to configure the cFE Software Bus
 **  either for each platform or for a mission as a whole.
 **/
-
diff --git a/fsw/cfe-core/src/inc/cfe_sb.h b/fsw/cfe-core/src/inc/cfe_sb.h
@@ -562,7 +562,7 @@ int32 CFE_SB_UnsubscribeLocal(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId);
 **
 ** \param[in]  MsgPtr       A pointer to the message to be sent.  This must point
 **                          to the first byte of the software bus message header
-**                          (#CFE_SB_Msg_t). 
+**                          ("::"CFE_SB_Msg_t). 
 **
 ** \return Execution status, see \ref CFEReturnCodes
 ** \retval #CFE_SUCCESS         \copybrief CFE_SUCCESS
@@ -595,7 +595,7 @@ int32  CFE_SB_SendMsg(CFE_SB_Msg_t   *MsgPtr);
 **
 ** \param[in]  MsgPtr       A pointer to the message to be sent.  This must point
 **                          to the first byte of the software bus message header
-**                          (#CFE_SB_Msg_t). 
+**                          ("::"CFE_SB_Msg_t). 
 **
 ** \return Execution status, see \ref CFEReturnCodes
 ** \retval #CFE_SUCCESS         \copybrief CFE_SUCCESS