Fix nasa#916, scrub headers in src/bsp and src/os

Ensure all headers have a consistent include guard and file block comment This gets all FSW code within src/os and src/bsp.
jphickey · Mar 25, 2021 · 6a3f0b7 · 6a3f0b7
1 parent 53f7f61
commit 6a3f0b7
Show file tree

Hide file tree

Showing 105 changed files with 350 additions and 232 deletions.
diff --git a/src/bsp/generic-linux/src/generic_linux_bsp_internal.h b/src/bsp/generic-linux/src/generic_linux_bsp_internal.h
@@ -18,15 +18,15 @@
  *  limitations under the License.
  */
 
-/*
- * File:  generic_linux_bsp_internal.h
+/**
+ * \file
  *
  * Purpose:
  *   Header file for internal data to the LINUX BSP
  */
 
-#ifndef GENERIC_LINUX_BSP_INTERNAL_H_
-#define GENERIC_LINUX_BSP_INTERNAL_H_
+#ifndef GENERIC_LINUX_BSP_INTERNAL_H
+#define GENERIC_LINUX_BSP_INTERNAL_H
 
 #include "osapi-common.h"
 #include "osapi-bsp.h"

diff --git a/src/bsp/generic-vxworks/src/generic_vxworks_bsp_internal.h b/src/bsp/generic-vxworks/src/generic_vxworks_bsp_internal.h
@@ -18,15 +18,15 @@
  *  limitations under the License.
  */
 
-/*
- * File:  generic_vxworks_bsp_internal.h
+/**
+ * \file
  *
  * Purpose:
  *   Header file for internal data to the VxWorks BSP
  */
 
-#ifndef GENERIC_VXWORKS_BSP_INTERNAL_H_
-#define GENERIC_VXWORKS_BSP_INTERNAL_H_
+#ifndef GENERIC_VXWORKS_BSP_INTERNAL_H
+#define GENERIC_VXWORKS_BSP_INTERNAL_H
 
 /*
 ** OSAL includes

diff --git a/src/bsp/pc-rtems/src/pcrtems_bsp_internal.h b/src/bsp/pc-rtems/src/pcrtems_bsp_internal.h
@@ -18,8 +18,8 @@
  *  limitations under the License.
  */
 
-/*
- * File:  pcrtems_bsp_internal.h
+/**
+ * \file
  *
  * Purpose:
  *   Header file for internal data to the PC-RTEMS BSP

diff --git a/src/bsp/shared/inc/bsp-impl.h b/src/bsp/shared/inc/bsp-impl.h
@@ -19,7 +19,8 @@
  */
 
 /**
- * \file   bsp-impl.h
+ * \file
+ *
  * \author [email protected]
  *
  * Purpose: Contains functions prototype definitions and variables declarations

diff --git a/src/os/inc/common_types.h b/src/os/inc/common_types.h
@@ -18,8 +18,8 @@
  *  limitations under the License.
  */
 
-/*
- *  Filename: common_types.h
+/**
+ * \file
  *
  *  Purpose:
  *	    Unit specification for common types.
@@ -184,4 +184,4 @@ extern "C"
 #define OSAL_INDEX_C(X)      ((osal_index_t)(X))
 #define OSAL_OBJTYPE_C(X)    ((osal_objtype_t)(X))
 
-#endif /* _common_types_ */
+#endif /* COMMON_TYPES_H */
diff --git a/src/os/inc/osapi-binsem.h b/src/os/inc/osapi-binsem.h
@@ -18,8 +18,10 @@
  *  limitations under the License.
  */
 
-/*
- * File: osapi-binsem.h
+/**
+ * \file
+ *
+ * Declarations and prototypes for binary semaphores
  */
 
 #ifndef OSAPI_BINSEM_H
@@ -200,4 +202,4 @@ int32 OS_BinSemGetInfo(osal_id_t sem_id, OS_bin_sem_prop_t *bin_prop);
 
 /**@}*/
 
-#endif
+#endif /* OSAPI_BINSEM_H */
diff --git a/src/os/inc/osapi-bsp.h b/src/os/inc/osapi-bsp.h
@@ -19,7 +19,9 @@
  */
 
 /**
- * @file osapi-bsp.h
+ * \file
+ *
+ * Declarations and prototypes for OSAL BSP
  */
 
 #ifndef OSAPI_BSP_H
@@ -92,4 +94,4 @@ void OS_BSP_SetExitCode(int32 code);
 
 /**@}*/
 
-#endif
+#endif /* OSAPI_BSP_H */
diff --git a/src/os/inc/osapi-clock.h b/src/os/inc/osapi-clock.h
@@ -19,7 +19,9 @@
  */
 
 /**
- * @file osapi-clock.h
+ * \file
+ *
+ * Declarations and prototypes for osapi-clock module
  */
 
 #ifndef OSAPI_CLOCK_H
@@ -402,4 +404,4 @@ static inline OS_time_t OS_TimeSubtract(OS_time_t time1, OS_time_t time2)
 
 /**@}*/
 
-#endif
+#endif /* OSAPI_CLOCK_H */
diff --git a/src/os/inc/osapi-common.h b/src/os/inc/osapi-common.h
@@ -18,8 +18,10 @@
  *  limitations under the License.
  */
 
-/*
- * @file osapi-common.h
+/**
+ * \file
+ *
+ * Declarations and prototypes for general OSAL functions that are not part of a subsystem
  */
 
 #ifndef OSAPI_COMMON_H
@@ -210,4 +212,4 @@ int32 OS_RegisterEventHandler(OS_EventHandler_t handler);
 
 /**@}*/
 
-#endif
+#endif /* OSAPI_COMMON_H */
diff --git a/src/os/inc/osapi-constants.h b/src/os/inc/osapi-constants.h
@@ -18,8 +18,10 @@
  *  limitations under the License.
  */
 
-/*
- * @file osapi-constants.h
+/**
+ * \file
+ *
+ * General constants for OSAL that are shared across subsystems
  */
 
 #ifndef OSAPI_CONSTANTS_H
@@ -53,4 +55,4 @@
  */
 #define OS_MAX_LOCAL_PATH_LEN (OS_MAX_PATH_LEN + OS_FS_PHYS_NAME_LEN)
 
-#endif
+#endif /* OSAPI_CONSTANTS_H */
diff --git a/src/os/inc/osapi-countsem.h b/src/os/inc/osapi-countsem.h
@@ -19,7 +19,9 @@
  */
 
 /**
- * @file osapi-countsem.h
+ * \file
+ *
+ * Declarations and prototypes for counting semaphores
  */
 
 #ifndef OSAPI_COUNTSEM_H
@@ -175,4 +177,4 @@ int32 OS_CountSemGetInfo(osal_id_t sem_id, OS_count_sem_prop_t *count_prop);
 
 /**@}*/
 
-#endif
+#endif /* OSAPI_COUNTSEM_H */
diff --git a/src/os/inc/osapi-dir.h b/src/os/inc/osapi-dir.h
@@ -19,7 +19,9 @@
  */
 
 /**
- * @file osapi-dir.h
+ * \file
+ *
+ * Declarations and prototypes for directories
  */
 
 #ifndef OSAPI_DIR_H
@@ -136,4 +138,4 @@ int32 OS_mkdir(const char *path, uint32 access);
 int32 OS_rmdir(const char *path);
 /**@}*/
 
-#endif
+#endif /* OSAPI_DIR_H */
diff --git a/src/os/inc/osapi-error.h b/src/os/inc/osapi-error.h
@@ -19,7 +19,9 @@
  */
 
 /**
- * @file osapi-error.h
+ * \file
+ *
+ * OSAL error code definitions
  */
 
 #ifndef OSAPI_ERROR_H
@@ -117,4 +119,4 @@ typedef char os_err_name_t[OS_ERROR_NAME_LENGTH];
 int32 OS_GetErrorName(int32 error_num, os_err_name_t *err_name);
 /**@}*/
 
-#endif
+#endif /* OSAPI_ERROR_H */
diff --git a/src/os/inc/osapi-file.h b/src/os/inc/osapi-file.h
@@ -19,7 +19,9 @@
  */
 
 /**
- * @file osapi-file.h
+ * \file
+ *
+ * Declarations and prototypes for file objects
  */
 
 #ifndef OSAPI_FILE_H
@@ -461,4 +463,4 @@ int32 OS_CloseAllFiles(void);
 int32 OS_CloseFileByName(const char *Filename);
 /**@}*/
 
-#endif
+#endif /* OSAPI_FILE_H */
diff --git a/src/os/inc/osapi-filesys.h b/src/os/inc/osapi-filesys.h
@@ -19,7 +19,9 @@
  */
 
 /**
- * @file osapi-filesys.h
+ * \file
+ *
+ * Declarations and prototypes for file systems
  */
 
 #ifndef OSAPI_FILESYS_H
@@ -77,7 +79,6 @@ typedef struct
  *
  *      OS_FileSysAddFixedMap(&fs_id, "/", "/root");
  *
- *
  * @param[out]  filesys_id  A non-zero OSAL ID reflecting the file system
  * @param[in]   phys_path   The native system directory (an existing mount point)
  * @param[in]   virt_path   The virtual mount point of this filesystem
@@ -279,4 +280,4 @@ int32 OS_TranslatePath(const char *VirtualPath, char *LocalPath);
 int32 OS_GetFsInfo(os_fsinfo_t *filesys_info);
 /**@}*/
 
-#endif
+#endif /* OSAPI_FILESYS_H */
diff --git a/src/os/inc/osapi-heap.h b/src/os/inc/osapi-heap.h
@@ -19,7 +19,9 @@
  */
 
 /**
- * @file osapi-heap.h
+ * \file
+ *
+ * Declarations and prototypes for heap functions
  */
 
 #ifndef OSAPI_HEAP_H
@@ -55,4 +57,4 @@ typedef struct
 int32 OS_HeapGetInfo(OS_heap_prop_t *heap_prop);
 /**@}*/
 
-#endif
+#endif /* OSAPI_HEAP_H */
diff --git a/src/os/inc/osapi-idmap.h b/src/os/inc/osapi-idmap.h
@@ -19,7 +19,9 @@
  */
 
 /**
- * @file osapi-idmap.h
+ * \file
+ *
+ * Declarations and prototypes for object IDs
  */
 
 #ifndef OSAPI_IDMAP_H
@@ -261,4 +263,4 @@ void OS_ForEachObjectOfType(osal_objtype_t objtype, osal_id_t creator_id, OS_Arg
 
 /**@}*/
 
-#endif
+#endif /* OSAPI_IDMAP_H */
diff --git a/src/os/inc/osapi-macros.h b/src/os/inc/osapi-macros.h
@@ -18,8 +18,10 @@
  *  limitations under the License.
  */
 
-/*
- * @file osapi-macros.h
+/**
+ * \file
+ *
+ * Macro definitions that are used across all OSAL subsystems
  */
 
 #ifndef OSAPI_MACROS_H
@@ -136,4 +138,4 @@
  */
 #define LENGTHCHECK(str, len, errcode) ARGCHECK(memchr(str, '\0', len), errcode)
 
-#endif
+#endif /* OSAPI_MACROS_H */
diff --git a/src/os/inc/osapi-module.h b/src/os/inc/osapi-module.h
@@ -19,7 +19,9 @@
  */
 
 /**
- * @file osapi-module.h
+ * \file
+ *
+ * Declarations and prototypes for module subsystem
  */
 
 #ifndef OSAPI_MODULE_H
@@ -231,4 +233,4 @@ int32 OS_ModuleUnload(osal_id_t module_id);
 int32 OS_ModuleInfo(osal_id_t module_id, OS_module_prop_t *module_info);
 /**@}*/
 
-#endif
+#endif /* OSAPI_MODULE_H */
diff --git a/src/os/inc/osapi-mutex.h b/src/os/inc/osapi-mutex.h
@@ -18,8 +18,10 @@
  *  limitations under the License.
  */
 
-/*
- * File: osapi-mutex.h
+/**
+ * \file
+ *
+ * Declarations and prototypes for mutexes
  */
 
 #ifndef OSAPI_MUTEX_H
@@ -149,4 +151,4 @@ int32 OS_MutSemGetIdByName(osal_id_t *sem_id, const char *sem_name);
 int32 OS_MutSemGetInfo(osal_id_t sem_id, OS_mut_sem_prop_t *mut_prop);
 /**@}*/
 
-#endif
+#endif /* OSAPI_MUTEX_H */
diff --git a/src/os/inc/osapi-network.h b/src/os/inc/osapi-network.h
@@ -18,8 +18,10 @@
  *  limitations under the License.
  */
 
-/*
- * @file osapi-network.h
+/**
+ * \file
+ *
+ * Declarations and prototypes for network subsystem
  */
 
 #ifndef OSAPI_NETWORK_H
@@ -68,4 +70,4 @@ int32 OS_NetworkGetHostName(char *host_name, size_t name_len);
 
 /**@}*/
 
-#endif
+#endif /* OSAPI_NETWORK_H */
diff --git a/src/os/inc/osapi-printf.h b/src/os/inc/osapi-printf.h
@@ -19,7 +19,9 @@
  */
 
 /**
- * @file osapi-printf.h
+ * \file
+ *
+ * Declarations and prototypes for printf/console output
  */
 
 #ifndef OSAPI_PRINTF_H
@@ -68,4 +70,4 @@ void OS_printf_disable(void);
 void OS_printf_enable(void);
 /**@}*/
 
-#endif
+#endif /* OSAPI_PRINTF_H */