Fix nasa#916, scrub headers in unit-test-coverage

Scrub all include guards and file scope doxygen comments in src/unit-test-coverage
jphickey · Mar 25, 2021 · 4ce8dec · 4ce8dec
1 parent fe5eb35
commit 4ce8dec
Show file tree

Hide file tree

Showing 182 changed files with 1,489 additions and 593 deletions.
diff --git a/src/unit-test-coverage/portable/adaptors/inc/ut-adaptor-portable-posix-files.h b/src/unit-test-coverage/portable/adaptors/inc/ut-adaptor-portable-posix-files.h
@@ -19,10 +19,10 @@
  */
 
 /**
- * \file     ut-adaptor-portable-posix-files.h
- * \ingroup  adaptors
- * \author   [email protected]
+ * \file
+ * \ingroup adaptors
  *
+ * Declarations and prototypes for ut-adaptor-portable-posix-files
  */
 
 #ifndef UT_ADAPTOR_PORTABLE_POSIX_FILES_H
@@ -34,4 +34,4 @@
 OCS_uid_t UT_PortablePosixFileTest_GetSelfEUID(void);
 OCS_gid_t UT_PortablePosixFileTest_GetSelfEGID(void);
 
-#endif /* UT_ADAPTOR_PORTABLE_POSIX_FILES_H  */
+#endif /* UT_ADAPTOR_PORTABLE_POSIX_FILES_H */
diff --git a/src/unit-test-coverage/portable/adaptors/inc/ut-adaptor-portable-posix-io.h b/src/unit-test-coverage/portable/adaptors/inc/ut-adaptor-portable-posix-io.h
@@ -19,10 +19,10 @@
  */
 
 /**
- * \file     ut-adaptor-portable-posix-io.h
- * \ingroup  adaptors
- * \author   [email protected]
+ * \file
+ * \ingroup adaptors
  *
+ * Declarations and prototypes for ut-adaptor-portable-posix-io
  */
 
 #ifndef UT_ADAPTOR_PORTABLE_POSIX_IO_H
@@ -43,4 +43,4 @@ void UT_PortablePosixIOTest_Set_FD(osal_index_t local_id, int fd);
 bool UT_PortablePosixIOTest_Get_Selectable(osal_index_t local_id);
 void UT_PortablePosixIOTest_ResetImpl(osal_index_t local_id);
 
-#endif /* UT_ADAPTOR_PORTABLE_POSIX_IO_H  */
+#endif /* UT_ADAPTOR_PORTABLE_POSIX_IO_H */
diff --git a/src/unit-test-coverage/portable/src/os-portable-coveragetest.h b/src/unit-test-coverage/portable/src/os-portable-coveragetest.h
@@ -19,10 +19,10 @@
  */
 
 /**
- * \file     os-portable-coveragetest.h
- * \ingroup  portable
- * \author   [email protected]
+ * \file
+ * \ingroup portable
  *
+ * Declarations and prototypes for os-portable-coveragetest
  */
 
 #ifndef OS_PORTABLE_COVERAGETEST_H
@@ -66,4 +66,4 @@
 void Osapi_Test_Setup(void);
 void Osapi_Test_Teardown(void);
 
-#endif /* OS_PORTABLE_COVERAGETEST_H  */
+#endif /* OS_PORTABLE_COVERAGETEST_H */
diff --git a/src/unit-test-coverage/shared/adaptors/inc/ut-adaptor-module.h b/src/unit-test-coverage/shared/adaptors/inc/ut-adaptor-module.h
@@ -19,10 +19,10 @@
  */
 
 /**
- * \file     ut-adaptor-module.h
- * \ingroup  adaptors
- * \author   [email protected]
+ * \file
+ * \ingroup adaptors
  *
+ * Declarations and prototypes for ut-adaptor-module
  */
 
 #ifndef UT_ADAPTOR_MODULE_H
@@ -52,4 +52,4 @@ void Test_DummyFunc(void);
 int32 Osapi_Call_SymbolLookup_Static(cpuaddr *SymbolAddress, const char *SymbolName, const char *ModuleName);
 int32 Osapi_Call_ModuleLoad_Static(const char *ModuleName);
 
-#endif /* UT_ADAPTOR_MODULE_H  */
+#endif /* UT_ADAPTOR_MODULE_H */
diff --git a/src/unit-test-coverage/shared/src/os-shared-coveragetest.h b/src/unit-test-coverage/shared/src/os-shared-coveragetest.h
@@ -19,10 +19,10 @@
  */
 
 /**
- * \file     os-shared-coveragetest.h
- * \ingroup  shared
- * \author   [email protected]
+ * \file
+ * \ingroup shared
  *
+ * Declarations and prototypes for os-shared-coveragetest
  */
 
 #ifndef OS_SHARED_COVERAGETEST_H
@@ -113,4 +113,4 @@ void Osapi_Test_Setup(void);
  */
 void Osapi_Test_Teardown(void);
 
-#endif /* OS_SHARED_COVERAGETEST_H  */
+#endif /* OS_SHARED_COVERAGETEST_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_arpa_inet.h b/src/unit-test-coverage/ut-stubs/inc/OCS_arpa_inet.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub replacement for arpa/inet.h */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub replacement for arpa/inet.h
+ */
+
 #ifndef OCS_ARPA_INET_H
 #define OCS_ARPA_INET_H
 
@@ -39,4 +45,4 @@
 extern const char *OCS_inet_ntop(int af, const void *cp, char *buf, size_t len);
 extern int         OCS_inet_pton(int af, const char *cp, void *buf);
 
-#endif /*  OCS_ARPA_INET_H */
+#endif /* OCS_ARPA_INET_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_assert.h b/src/unit-test-coverage/ut-stubs/inc/OCS_assert.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub replacement for assert.h */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub replacement for assert.h
+ */
+
 #ifndef OCS_ASSERT_H
 #define OCS_ASSERT_H
 
@@ -38,4 +44,4 @@
 
 void OCS_assert(bool expression);
 
-#endif /*  OCS_ASSERT_H */
+#endif /* OCS_ASSERT_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_basetypes.h b/src/unit-test-coverage/ut-stubs/inc/OCS_basetypes.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub basic data types */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub basic data types
+ */
+
 #ifndef OCS_BASETYPES_H
 #define OCS_BASETYPES_H
 
@@ -36,4 +42,4 @@
 #include <limits.h>  /* for correct INT_MAX, etc. */
 #include <stdbool.h> /* for correct boolean semantics */
 
-#endif /*  OCS_BASETYPES_H */
+#endif /* OCS_BASETYPES_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_blkIo.h b/src/unit-test-coverage/ut-stubs/inc/OCS_blkIo.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub basic data types */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub basic data types
+ */
+
 #ifndef OCS_BLKIO_H
 #define OCS_BLKIO_H
 
@@ -32,4 +38,4 @@ typedef struct OCS_BLK_DEV
 } OCS_BLK_DEV;
 typedef OCS_BLK_DEV *OCS_BLK_DEV_ID;
 
-#endif /*  OCS_BLKIO_H */
+#endif /* OCS_BLKIO_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_bsp-impl.h b/src/unit-test-coverage/ut-stubs/inc/OCS_bsp-impl.h
@@ -19,10 +19,8 @@
  */
 
 /**
- * \file     OCS_bsp-impl.h
- * \ingroup  ut-stubs
- * \author   [email protected]
- *
+ * \file
+ * \ingroup ut-stubs
  *
  * Purpose: Contains functions prototype definitions and variables declarations
  *          for the OSAL BSP layer
@@ -90,4 +88,4 @@ extern void OCS_OS_BSP_ConsoleOutput_Impl(const char *Str, size_t DataLen);
  ------------------------------------------------------------------*/
 extern void OCS_OS_BSP_ConsoleSetMode_Impl(uint32_t ModeBits);
 
-#endif /* OCS_BSP_IMPL_H  */
+#endif /* OCS_BSP_IMPL_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_cbioLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_cbioLib.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub replacement for cbioLib.h */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub replacement for cbioLib.h
+ */
+
 #ifndef OCS_CBIOLIB_H
 #define OCS_CBIOLIB_H
 
@@ -37,4 +43,4 @@
 /* prototypes normally declared in cbioLib.h */
 /* ----------------------------------------- */
 
-#endif /*  OCS_CBIOLIB_H */
+#endif /* OCS_CBIOLIB_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_complex.h b/src/unit-test-coverage/ut-stubs/inc/OCS_complex.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub replacement for complex.h */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub replacement for complex.h
+ */
+
 #ifndef OCS_COMPLEX_H
 #define OCS_COMPLEX_H
 
@@ -36,4 +42,4 @@
 /* prototypes normally declared in complex.h */
 /* ----------------------------------------- */
 
-#endif /*  OCS_COMPLEX_H */
+#endif /* OCS_COMPLEX_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_ctype.h b/src/unit-test-coverage/ut-stubs/inc/OCS_ctype.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub replacement for ctype.h */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub replacement for ctype.h
+ */
+
 #ifndef OCS_CTYPE_H
 #define OCS_CTYPE_H
 
@@ -38,4 +44,4 @@
 
 extern int OCS_isgraph(int c);
 
-#endif /*  OCS_CTYPE_H */
+#endif /* OCS_CTYPE_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_dirent.h b/src/unit-test-coverage/ut-stubs/inc/OCS_dirent.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub replacement for dirent.h */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub replacement for dirent.h
+ */
+
 #ifndef OCS_DIRENT_H
 #define OCS_DIRENT_H
 
@@ -48,4 +54,4 @@ extern OCS_DIR *          OCS_opendir(const char *name);
 extern struct OCS_dirent *OCS_readdir(OCS_DIR *dirp);
 extern void               OCS_rewinddir(OCS_DIR *dirp);
 
-#endif /*  OCS_DIRENT_H */
+#endif /* OCS_DIRENT_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_dlfcn.h b/src/unit-test-coverage/ut-stubs/inc/OCS_dlfcn.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub replacement for dlfcn.h */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub replacement for dlfcn.h
+ */
+
 #ifndef OCS_DLFCN_H
 #define OCS_DLFCN_H
 
@@ -41,4 +47,4 @@ extern char *OCS_dlerror(void);
 extern void *OCS_dlopen(const char *file, int flags);
 extern void *OCS_dlsym(void *handle, const char *name);
 
-#endif /*  OCS_DLFCN_H */
+#endif /* OCS_DLFCN_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_dosFsLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_dosFsLib.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub replacement for dosFsLib.h */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub replacement for dosFsLib.h
+ */
+
 #ifndef OCS_DOSFSLIB_H
 #define OCS_DOSFSLIB_H
 
@@ -43,4 +49,4 @@
 /* ----------------------------------------- */
 extern OCS_STATUS OCS_dosFsVolFormat(char *path, int opt, OCS_FUNCPTR pPromptFunc);
 
-#endif /*  OCS_DOSFSLIB_H */
+#endif /* OCS_DOSFSLIB_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_drv_hdisk_ataDrv.h b/src/unit-test-coverage/ut-stubs/inc/OCS_drv_hdisk_ataDrv.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub replacement for drv/hdisk/ataDrv.h */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub replacement for drv/hdisk/ataDrv.h
+ */
+
 #ifndef OCS_DRV_HDISK_ATADRV_H
 #define OCS_DRV_HDISK_ATADRV_H
 
@@ -39,4 +45,4 @@
 /* ----------------------------------------- */
 extern OCS_BLK_DEV *OCS_ataDevCreate(int ctrl, int drive, unsigned int nBlocks, unsigned int blkOffset);
 
-#endif /*  OCS_DRV_HDISK_ATADRV_H */
+#endif /* OCS_DRV_HDISK_ATADRV_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_errno.h b/src/unit-test-coverage/ut-stubs/inc/OCS_errno.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub replacement for errno.h */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub replacement for errno.h
+ */
+
 #ifndef OCS_ERRNO_H
 #define OCS_ERRNO_H
 
@@ -49,4 +55,4 @@
 
 extern int OCS_errno;
 
-#endif /*  OCS_ERRNO_H */
+#endif /* OCS_ERRNO_H */
diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_errnoLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_errnoLib.h
@@ -18,7 +18,13 @@
  *  limitations under the License.
  */
 
-/* OSAL coverage stub replacement for errnoLib.h */
+/**
+ * \file
+ * \ingroup ut-stubs
+ *
+ * OSAL coverage stub replacement for errnoLib.h
+ */
+
 #ifndef OCS_ERRNOLIB_H
 #define OCS_ERRNOLIB_H
 
@@ -39,4 +45,4 @@
 
 extern int OCS_errnoGet(void);
 
-#endif /*  OCS_ERRNOLIB_H */
+#endif /* OCS_ERRNOLIB_H */