Merge pull request #40 from skliper/fix39-doxygen_ubuntu

Fix #39, Resolve usersguide issues with doxygen 1.8.17
nasa · Sep 16, 2022 · 291dc0f · 291dc0f
2 parents 118a8ba + 24f96b6
commit 291dc0f
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 13 deletions.
diff --git a/fsw/src/mm_dump.h b/fsw/src/mm_dump.h
@@ -139,10 +139,7 @@ bool MM_WriteFileHeaders(const char *FileName, osal_id_t FileHandle, CFE_FS_Head
  *
  *  \param [in]   SrcAddress   The source address to read from
  *  \param [in]   CmdPtr       Pointer to dump in event command message
- *  \param [in]   DumpBuffer   A pointer to the byte array to store
- *                             the dump data in
- *  \param [out]  *DumpBuffer  A pointer to the byte array holding the
- *                             dump data
+ *  \param [out]  DumpBuffer   Byte array holding the dump data
  *
  *  \return Boolean execution status
  *  \retval true  Dump in event buffer successful

diff --git a/fsw/src/mm_load.h b/fsw/src/mm_load.h
@@ -146,11 +146,9 @@ bool MM_VerifyLoadFileSize(const char *FileName, const MM_LoadDumpFileHeader_t *
  *                             the file name (used only for error event
  *                             messages).
  *  \param [in]   FileHandle   File handle to read header from
- *  \param [in]   CFEHeader    Pointer to CFE file header
- *  \param [in]   MMHeader     Pointer to MM file header
- *  \param [out]  *CFEHeader   Contents of the cFE primary file header
+ *  \param [out]  CFEHeader    Contents of the cFE primary file header
  *                             structure for the specified file.
- *  \param [out]  *MMHeader    Contents of the MM secondary file header
+ *  \param [out]  MMHeader     Contents of the MM secondary file header
  *                             structure for the specified file.
  *
  *  \return Boolean execution status

diff --git a/fsw/src/mm_utils.h b/fsw/src/mm_utils.h
@@ -190,9 +190,7 @@ bool MM_Verify16Aligned(cpuaddr Address, uint32 Size);
  *
  *  \param [in]   SymAddr          A #MM_SymAddr_t pointer that holds
  *                                 the symbol name and optional offset
- *  \param [in]   ResolvedAddr     A pointer to the location to store
- *                                 the resolved address in
- *  \param [out]  *ResolvedAddr    The fully resolved address. Only valid
+ *  \param [out]  ResolvedAddr     The fully resolved address. Only valid
  *                                 if the return value is TRUE
  *
  *  \return Boolean execution status
@@ -215,9 +213,8 @@ bool MM_ResolveSymAddr(MM_SymAddr_t *SymAddr, cpuaddr *ResolvedAddr);
  *       file pointer to the end of file
  *
  *  \param [in]   FileHandle   The open file handle of the file to scan
- *  \param [in]   CrcPtr       Where to store the computed CRC.
  *  \param [in]   TypeCRC      CRC type to compute
- *  \param [out]  *CrcPtr      The computed CRC. Only updated if the return
+ *  \param [out]  CrcPtr       The computed CRC. Only updated if the return
  *                             value is #OS_SUCCESS
  *
  *  \return Execution status, see \ref OSReturnCodes