diff --git a/src/bsp/generic-linux/src/generic_linux_bsp_internal.h b/src/bsp/generic-linux/src/generic_linux_bsp_internal.h index 85ab8145e..716c09b50 100644 --- 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 index 640603c4a..084c0345e 100644 --- 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 index 67f7ff1cb..653c62fb6 100644 --- 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 index 73f2ce4eb..d6aa87da5 100644 --- a/src/bsp/shared/inc/bsp-impl.h +++ b/src/bsp/shared/inc/bsp-impl.h @@ -19,8 +19,7 @@ */ /** - * \file bsp-impl.h - * \author joseph.p.hickey@nasa.gov + * \file * * Purpose: Contains functions prototype definitions and variables declarations * for the OSAL BSP layer diff --git a/src/os/inc/common_types.h b/src/os/inc/common_types.h index 108f1004b..411407452 100644 --- 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. @@ -156,4 +156,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 index 4474450bc..21335fc29 100644 --- 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 index 3fa39d140..4f4c7ee18 100644 --- 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 index b2fb0349d..e13d06635 100644 --- 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 index ac6b1bcdc..58e76d38b 100644 --- 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 index e3aa32f1c..ecd84283b 100644 --- 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 index b74cde754..8fd194a6e 100644 --- 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 index d29a1f196..4d7963ca0 100644 --- 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 index b623292ca..b94982993 100644 --- 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 @@ -118,4 +120,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 index 413515876..267c24b2d 100644 --- 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 index b8fc9f30a..c9d0d567b 100644 --- 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 index 5bdd32973..690b95e82 100644 --- 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 index cd93b0f3e..345446227 100644 --- 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 index 120499a51..594ddee7f 100644 --- 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 index d6f60fde6..634b981b2 100644 --- 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 index d7ba1664c..b7be53b42 100644 --- 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 index 391492249..bce88e364 100644 --- 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 index 6e072419b..75fc7983e 100644 --- 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 */ diff --git a/src/os/inc/osapi-queue.h b/src/os/inc/osapi-queue.h index 3bc5a877a..69a9222dc 100644 --- a/src/os/inc/osapi-queue.h +++ b/src/os/inc/osapi-queue.h @@ -19,7 +19,9 @@ */ /** - * @file osapi-queue.h + * \file + * + * Declarations and prototypes for queue subsystem */ #ifndef OSAPI_QUEUE_H @@ -48,7 +50,6 @@ typedef struct * the queue. Queue names must be unique; if the name already exists this * function fails. Names cannot be NULL. * - * * @param[out] queue_id will be set to the non-zero ID of the newly-created resource * @param[in] queue_name the name of the new resource to create * @param[in] queue_depth the maximum depth of the queue @@ -163,4 +164,4 @@ int32 OS_QueueGetIdByName(osal_id_t *queue_id, const char *queue_name); int32 OS_QueueGetInfo(osal_id_t queue_id, OS_queue_prop_t *queue_prop); /**@}*/ -#endif +#endif /* OSAPI_QUEUE_H */ diff --git a/src/os/inc/osapi-select.h b/src/os/inc/osapi-select.h index 0d4ced4b3..e0c74a863 100644 --- a/src/os/inc/osapi-select.h +++ b/src/os/inc/osapi-select.h @@ -19,7 +19,9 @@ */ /** - * @file osapi-select.h + * \file + * + * Declarations and prototypes for select abstraction */ #ifndef OSAPI_SELECT_H @@ -158,4 +160,4 @@ int32 OS_SelectFdClear(OS_FdSet *Set, osal_id_t objid); bool OS_SelectFdIsSet(OS_FdSet *Set, osal_id_t objid); /**@}*/ -#endif +#endif /* OSAPI_SELECT_H */ diff --git a/src/os/inc/osapi-shell.h b/src/os/inc/osapi-shell.h index 914f0775f..c51169efd 100644 --- a/src/os/inc/osapi-shell.h +++ b/src/os/inc/osapi-shell.h @@ -19,7 +19,9 @@ */ /** - * @file osapi-shell.h + * \file + * + * Declarations and prototypes for shell abstraction */ #ifndef OSAPI_SHELL_H @@ -51,4 +53,4 @@ int32 OS_ShellOutputToFile(const char *Cmd, osal_id_t filedes); /**@}*/ -#endif +#endif /* OSAPI_SHELL_H */ diff --git a/src/os/inc/osapi-sockets.h b/src/os/inc/osapi-sockets.h index 92c5f567c..09e3b5a75 100644 --- a/src/os/inc/osapi-sockets.h +++ b/src/os/inc/osapi-sockets.h @@ -19,7 +19,9 @@ */ /** - * @file osapi-sockets.h + * \file + * + * Declarations and prototypes for sockets abstraction */ #ifndef OSAPI_SOCKETS_H @@ -370,4 +372,4 @@ int32 OS_SocketGetInfo(osal_id_t sock_id, OS_socket_prop_t *sock_prop); /**@}*/ -#endif +#endif /* OSAPI_SOCKETS_H */ diff --git a/src/os/inc/osapi-task.h b/src/os/inc/osapi-task.h index 97b29b7cf..6437f8f0f 100644 --- a/src/os/inc/osapi-task.h +++ b/src/os/inc/osapi-task.h @@ -19,7 +19,9 @@ */ /** - * @file osapi-task.h + * \file + * + * Declarations and prototypes for task abstraction */ #ifndef OSAPI_TASK_H @@ -237,4 +239,4 @@ int32 OS_TaskFindIdBySystemData(osal_id_t *task_id, const void *sysdata, size_t /**@}*/ -#endif +#endif /* OSAPI_TASK_H */ diff --git a/src/os/inc/osapi-timebase.h b/src/os/inc/osapi-timebase.h index 1e709ee2b..3d2dd74a6 100644 --- a/src/os/inc/osapi-timebase.h +++ b/src/os/inc/osapi-timebase.h @@ -18,8 +18,10 @@ * limitations under the License. */ -/* - * @file osapi-timebase.h +/** + * \file + * + * Declarations and prototypes for timebase abstraction */ #ifndef OSAPI_TIMEBASE_H @@ -185,4 +187,4 @@ int32 OS_TimeBaseGetFreeRun(osal_id_t timebase_id, uint32 *freerun_val); /**@}*/ -#endif +#endif /* OSAPI_TIMEBASE_H */ diff --git a/src/os/inc/osapi-timer.h b/src/os/inc/osapi-timer.h index 785364eb4..eaf9148d6 100644 --- a/src/os/inc/osapi-timer.h +++ b/src/os/inc/osapi-timer.h @@ -19,7 +19,9 @@ */ /** - * @file osapi-timer.h + * \file + * + * Declarations and prototypes for timer abstraction (app callbacks) */ #ifndef OSAPI_TIMER_H @@ -208,4 +210,4 @@ int32 OS_TimerGetIdByName(osal_id_t *timer_id, const char *timer_name); int32 OS_TimerGetInfo(osal_id_t timer_id, OS_timer_prop_t *timer_prop); /**@}*/ -#endif +#endif /* OSAPI_TIMER_H */ diff --git a/src/os/inc/osapi-version.h b/src/os/inc/osapi-version.h index e7182a964..56ab0d2e8 100644 --- a/src/os/inc/osapi-version.h +++ b/src/os/inc/osapi-version.h @@ -18,12 +18,14 @@ * limitations under the License. */ -/*! @file osapi-version.h - * @brief Purpose: - * @details Provide version identifiers for cFS' Operating System Abstraction Layer +/** + * \file + * + * Provide version identifiers for cFS' Operating System Abstraction Layer * See @ref cfsversions for version and build number and description * */ + #ifndef OSAPI_VERSION_H #define OSAPI_VERSION_H @@ -151,7 +153,3 @@ void OS_GetVersionNumber(uint8 VersionNumbers[4]); uint32 OS_GetBuildNumber(void); #endif /* OSAPI_VERSION_H */ - -/************************/ -/* End of File Comment */ -/************************/ diff --git a/src/os/inc/osapi.h b/src/os/inc/osapi.h index 11701501a..37cd6a18d 100644 --- a/src/os/inc/osapi.h +++ b/src/os/inc/osapi.h @@ -18,10 +18,8 @@ * limitations under the License. */ -/* - * File: osapi.h - * - * Author: Alan Cudmore - Code 582 +/** + * \file * * Purpose: Contains functions prototype definitions and variables declarations * for the OS Abstraction Layer, Core OS module @@ -102,4 +100,4 @@ extern "C" } #endif -#endif +#endif /* OSAPI_H */ diff --git a/src/os/posix/inc/os-impl-binsem.h b/src/os/posix/inc/os-impl-binsem.h index 356ec8e94..72e0442ad 100644 --- a/src/os/posix/inc/os-impl-binsem.h +++ b/src/os/posix/inc/os-impl-binsem.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-binsem.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -44,4 +44,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_binsem_internal_record_t OS_impl_bin_sem_table[OS_MAX_BIN_SEMAPHORES]; -#endif /* OS_IMPL_BINSEM_H */ +#endif /* OS_IMPL_BINSEM_H */ diff --git a/src/os/posix/inc/os-impl-console.h b/src/os/posix/inc/os-impl-console.h index 3ed7ac81f..ac0140053 100644 --- a/src/os/posix/inc/os-impl-console.h +++ b/src/os/posix/inc/os-impl-console.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-console.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -42,4 +42,4 @@ typedef struct extern OS_impl_console_internal_record_t OS_impl_console_table[OS_MAX_CONSOLES]; -#endif /* OS_IMPL_CONSOLE_H */ +#endif /* OS_IMPL_CONSOLE_H */ diff --git a/src/os/posix/inc/os-impl-countsem.h b/src/os/posix/inc/os-impl-countsem.h index 176fcd9ec..427df7d85 100644 --- a/src/os/posix/inc/os-impl-countsem.h +++ b/src/os/posix/inc/os-impl-countsem.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-countsem.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -39,4 +39,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_countsem_internal_record_t OS_impl_count_sem_table[OS_MAX_COUNT_SEMAPHORES]; -#endif /* OS_IMPL_COUNTSEM_H */ +#endif /* OS_IMPL_COUNTSEM_H */ diff --git a/src/os/posix/inc/os-impl-dirs.h b/src/os/posix/inc/os-impl-dirs.h index e10b8e185..7b03e0391 100644 --- a/src/os/posix/inc/os-impl-dirs.h +++ b/src/os/posix/inc/os-impl-dirs.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-dirs.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -45,4 +45,4 @@ typedef struct */ extern OS_impl_dir_internal_record_t OS_impl_dir_table[OS_MAX_NUM_OPEN_DIRS]; -#endif /* OS_IMPL_DIRS_H */ +#endif /* OS_IMPL_DIRS_H */ diff --git a/src/os/posix/inc/os-impl-files.h b/src/os/posix/inc/os-impl-files.h index ec9f1e01c..2589ff8ab 100644 --- a/src/os/posix/inc/os-impl-files.h +++ b/src/os/posix/inc/os-impl-files.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-files.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -48,4 +48,4 @@ extern gid_t OS_IMPL_SELF_EGID; extern const int OS_IMPL_REGULAR_FILE_FLAGS; -#endif /* OS_IMPL_FILES_H */ +#endif /* OS_IMPL_FILES_H */ diff --git a/src/os/posix/inc/os-impl-gettime.h b/src/os/posix/inc/os-impl-gettime.h index c48d6f324..279e50629 100644 --- a/src/os/posix/inc/os-impl-gettime.h +++ b/src/os/posix/inc/os-impl-gettime.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-gettime.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -33,4 +33,4 @@ #define OSAL_GETTIME_SOURCE_CLOCK CLOCK_MONOTONIC -#endif /* OS_IMPL_GETTIME_H */ +#endif /* OS_IMPL_GETTIME_H */ diff --git a/src/os/posix/inc/os-impl-idmap.h b/src/os/posix/inc/os-impl-idmap.h index 00194e1ac..3cb9cef35 100644 --- a/src/os/posix/inc/os-impl-idmap.h +++ b/src/os/posix/inc/os-impl-idmap.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-idmap.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -41,4 +41,4 @@ typedef struct /* Tables where the lock state information is stored */ extern OS_impl_objtype_lock_t *const OS_impl_objtype_lock_table[OS_OBJECT_TYPE_USER]; -#endif /* OS_IMPL_IDMAP_H */ +#endif /* OS_IMPL_IDMAP_H */ diff --git a/src/os/posix/inc/os-impl-io.h b/src/os/posix/inc/os-impl-io.h index 9db8e7c81..ddf67ca39 100644 --- a/src/os/posix/inc/os-impl-io.h +++ b/src/os/posix/inc/os-impl-io.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-io.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -48,4 +48,4 @@ typedef struct */ extern OS_impl_file_internal_record_t OS_impl_filehandle_table[OS_MAX_NUM_OPEN_FILES]; -#endif /* OS_IMPL_IO_H */ +#endif /* OS_IMPL_IO_H */ diff --git a/src/os/posix/inc/os-impl-loader.h b/src/os/posix/inc/os-impl-loader.h index b7dc4b641..d3078e0e3 100644 --- a/src/os/posix/inc/os-impl-loader.h +++ b/src/os/posix/inc/os-impl-loader.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-loader.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -52,4 +52,4 @@ typedef struct */ extern OS_impl_module_internal_record_t OS_impl_module_table[OS_MAX_MODULES]; -#endif /* OS_IMPL_LOADER_H */ +#endif /* OS_IMPL_LOADER_H */ diff --git a/src/os/posix/inc/os-impl-mutex.h b/src/os/posix/inc/os-impl-mutex.h index 61db43dbf..47d124154 100644 --- a/src/os/posix/inc/os-impl-mutex.h +++ b/src/os/posix/inc/os-impl-mutex.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-mutex.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -40,4 +40,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_mutex_internal_record_t OS_impl_mutex_table[OS_MAX_MUTEXES]; -#endif /* OS_IMPL_MUTEX_H */ +#endif /* OS_IMPL_MUTEX_H */ diff --git a/src/os/posix/inc/os-impl-network.h b/src/os/posix/inc/os-impl-network.h index 977f978d6..c8f7c646a 100644 --- a/src/os/posix/inc/os-impl-network.h +++ b/src/os/posix/inc/os-impl-network.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-network.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -30,4 +30,4 @@ #include -#endif /* OS_IMPL_NETWORK_H */ +#endif /* OS_IMPL_NETWORK_H */ diff --git a/src/os/posix/inc/os-impl-queues.h b/src/os/posix/inc/os-impl-queues.h index 673b6a0a0..edaae5a8e 100644 --- a/src/os/posix/inc/os-impl-queues.h +++ b/src/os/posix/inc/os-impl-queues.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-queues.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -40,4 +40,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_queue_internal_record_t OS_impl_queue_table[OS_MAX_QUEUES]; -#endif /* OS_IMPL_QUEUES_H */ +#endif /* OS_IMPL_QUEUES_H */ diff --git a/src/os/posix/inc/os-impl-select.h b/src/os/posix/inc/os-impl-select.h index bdcdc9ba0..32df728c3 100644 --- a/src/os/posix/inc/os-impl-select.h +++ b/src/os/posix/inc/os-impl-select.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-select.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -33,4 +33,4 @@ #include #include -#endif /* OS_IMPL_SELECT_H */ +#endif /* OS_IMPL_SELECT_H */ diff --git a/src/os/posix/inc/os-impl-sockets.h b/src/os/posix/inc/os-impl-sockets.h index 217253246..adae73696 100644 --- a/src/os/posix/inc/os-impl-sockets.h +++ b/src/os/posix/inc/os-impl-sockets.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-sockets.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -43,4 +43,4 @@ */ #define OS_IMPL_SOCKET_FLAGS O_NONBLOCK -#endif /* OS_IMPL_SOCKETS_H */ +#endif /* OS_IMPL_SOCKETS_H */ diff --git a/src/os/posix/inc/os-impl-tasks.h b/src/os/posix/inc/os-impl-tasks.h index 879baed6c..0351f74b6 100644 --- a/src/os/posix/inc/os-impl-tasks.h +++ b/src/os/posix/inc/os-impl-tasks.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-tasks.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -45,4 +45,4 @@ extern OS_impl_task_internal_record_t OS_impl_task_table[OS_MAX_TASKS]; int32 OS_Posix_InternalTaskCreate_Impl(pthread_t *pthr, osal_priority_t priority, size_t stacksz, PthreadFuncPtr_t entry, void *entry_arg); -#endif /* OS_IMPL_TASKS_H */ +#endif /* OS_IMPL_TASKS_H */ diff --git a/src/os/posix/inc/os-impl-timebase.h b/src/os/posix/inc/os-impl-timebase.h index a995f4b8b..a91a48b5c 100644 --- a/src/os/posix/inc/os-impl-timebase.h +++ b/src/os/posix/inc/os-impl-timebase.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-timebase.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * */ @@ -50,4 +50,4 @@ typedef struct extern OS_impl_timebase_internal_record_t OS_impl_timebase_table[OS_MAX_TIMEBASES]; -#endif /* OS_IMPL_TIMEBASE_H */ +#endif /* OS_IMPL_TIMEBASE_H */ diff --git a/src/os/posix/inc/os-posix.h b/src/os/posix/inc/os-posix.h index 33105f97d..02e7d3ee0 100644 --- a/src/os/posix/inc/os-posix.h +++ b/src/os/posix/inc/os-posix.h @@ -19,9 +19,9 @@ */ /** - * \file os-posix.h + * \file + * * \ingroup posix - * \author joseph.p.hickey@nasa.gov * * Purpose: This file contains definitions that are shared across the POSIX * OSAL implementation. This file is private to the POSIX port and it @@ -34,7 +34,6 @@ /**************************************************************************************** COMMON INCLUDE FILES ***************************************************************************************/ - #include #include #include @@ -109,4 +108,4 @@ int32 OS_Posix_TableMutex_Init(osal_objtype_t idtype); void OS_Posix_CompAbsDelayTime(uint32 msecs, struct timespec *tm); -#endif /* OS_POSIX_H */ +#endif /* OS_POSIX_H */ diff --git a/src/os/rtems/inc/os-impl-binsem.h b/src/os/rtems/inc/os-impl-binsem.h index 7437e6c5b..038d2b0f7 100644 --- a/src/os/rtems/inc/os-impl-binsem.h +++ b/src/os/rtems/inc/os-impl-binsem.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-binsem.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -39,4 +39,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_binsem_internal_record_t OS_impl_bin_sem_table[OS_MAX_BIN_SEMAPHORES]; -#endif /* OS_IMPL_BINSEM_H */ +#endif /* OS_IMPL_BINSEM_H */ diff --git a/src/os/rtems/inc/os-impl-console.h b/src/os/rtems/inc/os-impl-console.h index 03663aad9..b015783a9 100644 --- a/src/os/rtems/inc/os-impl-console.h +++ b/src/os/rtems/inc/os-impl-console.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-console.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -42,4 +42,4 @@ typedef struct extern OS_impl_console_internal_record_t OS_impl_console_table[OS_MAX_CONSOLES]; -#endif /* OS_IMPL_CONSOLE_H */ +#endif /* OS_IMPL_CONSOLE_H */ diff --git a/src/os/rtems/inc/os-impl-countsem.h b/src/os/rtems/inc/os-impl-countsem.h index 5070ee6db..6a58ee548 100644 --- a/src/os/rtems/inc/os-impl-countsem.h +++ b/src/os/rtems/inc/os-impl-countsem.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-countsem.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -39,4 +39,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_countsem_internal_record_t OS_impl_count_sem_table[OS_MAX_COUNT_SEMAPHORES]; -#endif /* OS_IMPL_COUNTSEM_H */ +#endif /* OS_IMPL_COUNTSEM_H */ diff --git a/src/os/rtems/inc/os-impl-dirs.h b/src/os/rtems/inc/os-impl-dirs.h index 8db0eee60..8a11f648f 100644 --- a/src/os/rtems/inc/os-impl-dirs.h +++ b/src/os/rtems/inc/os-impl-dirs.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-dirs.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -45,4 +45,4 @@ typedef struct */ extern OS_impl_dir_internal_record_t OS_impl_dir_table[OS_MAX_NUM_OPEN_DIRS]; -#endif /* OS_IMPL_DIRS_H */ +#endif /* OS_IMPL_DIRS_H */ diff --git a/src/os/rtems/inc/os-impl-files.h b/src/os/rtems/inc/os-impl-files.h index c15b915b6..6331ce7a7 100644 --- a/src/os/rtems/inc/os-impl-files.h +++ b/src/os/rtems/inc/os-impl-files.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-files.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -42,4 +42,4 @@ #define OS_IMPL_REGULAR_FILE_FLAGS 0 -#endif /* OS_IMPL_FILES_H */ +#endif /* OS_IMPL_FILES_H */ diff --git a/src/os/rtems/inc/os-impl-gettime.h b/src/os/rtems/inc/os-impl-gettime.h index 28690e350..65e392c49 100644 --- a/src/os/rtems/inc/os-impl-gettime.h +++ b/src/os/rtems/inc/os-impl-gettime.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-gettime.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -33,4 +33,4 @@ #define OSAL_GETTIME_SOURCE_CLOCK CLOCK_MONOTONIC -#endif /* OS_IMPL_GETTIME_H */ +#endif /* OS_IMPL_GETTIME_H */ diff --git a/src/os/rtems/inc/os-impl-idmap.h b/src/os/rtems/inc/os-impl-idmap.h index 1f0285192..2bf478828 100644 --- a/src/os/rtems/inc/os-impl-idmap.h +++ b/src/os/rtems/inc/os-impl-idmap.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-idmap.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -40,4 +40,4 @@ typedef struct /* Tables where the lock state information is stored */ extern OS_impl_objtype_lock_t *const OS_impl_objtype_lock_table[OS_OBJECT_TYPE_USER]; -#endif /* OS_IMPL_IDMAP_H */ +#endif /* OS_IMPL_IDMAP_H */ diff --git a/src/os/rtems/inc/os-impl-io.h b/src/os/rtems/inc/os-impl-io.h index da6432214..8c56ccba4 100644 --- a/src/os/rtems/inc/os-impl-io.h +++ b/src/os/rtems/inc/os-impl-io.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-io.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -46,4 +46,4 @@ typedef struct */ extern OS_impl_file_internal_record_t OS_impl_filehandle_table[OS_MAX_NUM_OPEN_FILES]; -#endif /* OS_IMPL_IO_H */ +#endif /* OS_IMPL_IO_H */ diff --git a/src/os/rtems/inc/os-impl-loader.h b/src/os/rtems/inc/os-impl-loader.h index 12503c023..f1e0063bd 100644 --- a/src/os/rtems/inc/os-impl-loader.h +++ b/src/os/rtems/inc/os-impl-loader.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-loader.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -50,4 +50,4 @@ typedef struct extern OS_impl_module_internal_record_t OS_impl_module_table[OS_MAX_MODULES]; -#endif /* OS_IMPL_LOADER_H */ +#endif /* OS_IMPL_LOADER_H */ diff --git a/src/os/rtems/inc/os-impl-mutex.h b/src/os/rtems/inc/os-impl-mutex.h index be17d462a..eb2827bfa 100644 --- a/src/os/rtems/inc/os-impl-mutex.h +++ b/src/os/rtems/inc/os-impl-mutex.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-mutex.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -39,4 +39,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_mutex_internal_record_t OS_impl_mutex_table[OS_MAX_MUTEXES]; -#endif /* OS_IMPL_MUTEX_H */ +#endif /* OS_IMPL_MUTEX_H */ diff --git a/src/os/rtems/inc/os-impl-queues.h b/src/os/rtems/inc/os-impl-queues.h index 354abec24..0fc4533ce 100644 --- a/src/os/rtems/inc/os-impl-queues.h +++ b/src/os/rtems/inc/os-impl-queues.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-queues.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -39,4 +39,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_queue_internal_record_t OS_impl_queue_table[OS_MAX_QUEUES]; -#endif /* OS_IMPL_QUEUES_H */ +#endif /* OS_IMPL_QUEUES_H */ diff --git a/src/os/rtems/inc/os-impl-select.h b/src/os/rtems/inc/os-impl-select.h index 4e6164365..be08f819a 100644 --- a/src/os/rtems/inc/os-impl-select.h +++ b/src/os/rtems/inc/os-impl-select.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-select.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -33,4 +33,4 @@ #include #include -#endif /* OS_IMPL_SELECT_H */ +#endif /* OS_IMPL_SELECT_H */ diff --git a/src/os/rtems/inc/os-impl-sockets.h b/src/os/rtems/inc/os-impl-sockets.h index a1e557801..085860ab8 100644 --- a/src/os/rtems/inc/os-impl-sockets.h +++ b/src/os/rtems/inc/os-impl-sockets.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-sockets.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -43,4 +43,4 @@ */ #define OS_IMPL_SOCKET_FLAGS O_NONBLOCK -#endif /* OS_IMPL_SOCKETS_H */ +#endif /* OS_IMPL_SOCKETS_H */ diff --git a/src/os/rtems/inc/os-impl-tasks.h b/src/os/rtems/inc/os-impl-tasks.h index d8fb5dd47..679e60066 100644 --- a/src/os/rtems/inc/os-impl-tasks.h +++ b/src/os/rtems/inc/os-impl-tasks.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-tasks.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -39,4 +39,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_task_internal_record_t OS_impl_task_table[OS_MAX_TASKS]; -#endif /* OS_IMPL_TASKS_H */ +#endif /* OS_IMPL_TASKS_H */ diff --git a/src/os/rtems/inc/os-impl-timebase.h b/src/os/rtems/inc/os-impl-timebase.h index 998d6354f..c651aaae1 100644 --- a/src/os/rtems/inc/os-impl-timebase.h +++ b/src/os/rtems/inc/os-impl-timebase.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-timebase.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * */ @@ -50,4 +50,4 @@ typedef struct extern OS_impl_timebase_internal_record_t OS_impl_timebase_table[OS_MAX_TIMEBASES]; -#endif /* OS_IMPL_TIMEBASE_H */ +#endif /* OS_IMPL_TIMEBASE_H */ diff --git a/src/os/rtems/inc/os-rtems.h b/src/os/rtems/inc/os-rtems.h index 4b9a9d2a4..b22abbe87 100644 --- a/src/os/rtems/inc/os-rtems.h +++ b/src/os/rtems/inc/os-rtems.h @@ -19,9 +19,9 @@ */ /** - * \file os-rtems.h + * \file + * * \ingroup rtems - * \author joseph.p.hickey@nasa.gov * * Purpose: This file contains definitions that are shared across the RTEMS * OSAL implementation. This file is private to the RTEMS port and it @@ -100,4 +100,4 @@ int32 OS_Rtems_FileSysAPI_Impl_Init(void); int32 OS_Rtems_TableMutex_Init(osal_objtype_t idtype); -#endif /* OS_RTEMS_H */ +#endif /* OS_RTEMS_H */ diff --git a/src/os/shared/inc/os-shared-binsem.h b/src/os/shared/inc/os-shared-binsem.h index 9ae72ba85..e04142cd0 100644 --- a/src/os/shared/inc/os-shared-binsem.h +++ b/src/os/shared/inc/os-shared-binsem.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-binsem.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -122,4 +122,4 @@ int32 OS_BinSemDelete_Impl(const OS_object_token_t *token); ------------------------------------------------------------------*/ int32 OS_BinSemGetInfo_Impl(const OS_object_token_t *token, OS_bin_sem_prop_t *bin_prop); -#endif /* OS_SHARED_BINSEM_H */ +#endif /* OS_SHARED_BINSEM_H */ diff --git a/src/os/shared/inc/os-shared-clock.h b/src/os/shared/inc/os-shared-clock.h index 9619f9bf1..ed6642ccb 100644 --- a/src/os/shared/inc/os-shared-clock.h +++ b/src/os/shared/inc/os-shared-clock.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-clock.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -54,4 +54,4 @@ int32 OS_GetLocalTime_Impl(OS_time_t *time_struct); ------------------------------------------------------------------*/ int32 OS_SetLocalTime_Impl(const OS_time_t *time_struct); -#endif /* OS_SHARED_CLOCK_H */ +#endif /* OS_SHARED_CLOCK_H */ diff --git a/src/os/shared/inc/os-shared-common.h b/src/os/shared/inc/os-shared-common.h index 32927226f..d5bc78e4a 100644 --- a/src/os/shared/inc/os-shared-common.h +++ b/src/os/shared/inc/os-shared-common.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-common.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -151,4 +151,4 @@ static inline size_t OS_strnlen(const char *s, size_t maxlen) return maxlen; } -#endif /* OS_SHARED_COMMON_H */ +#endif /* OS_SHARED_COMMON_H */ diff --git a/src/os/shared/inc/os-shared-countsem.h b/src/os/shared/inc/os-shared-countsem.h index 67099b5bb..95057629b 100644 --- a/src/os/shared/inc/os-shared-countsem.h +++ b/src/os/shared/inc/os-shared-countsem.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-countsem.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -112,4 +112,4 @@ int32 OS_CountSemDelete_Impl(const OS_object_token_t *token); ------------------------------------------------------------------*/ int32 OS_CountSemGetInfo_Impl(const OS_object_token_t *token, OS_count_sem_prop_t *count_prop); -#endif /* OS_SHARED_COUNTSEM_H */ +#endif /* OS_SHARED_COUNTSEM_H */ diff --git a/src/os/shared/inc/os-shared-dir.h b/src/os/shared/inc/os-shared-dir.h index 52bc5da22..e47b8a682 100644 --- a/src/os/shared/inc/os-shared-dir.h +++ b/src/os/shared/inc/os-shared-dir.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-dir.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -111,4 +111,4 @@ int32 OS_DirRewind_Impl(const OS_object_token_t *token); ------------------------------------------------------------------*/ int32 OS_DirRemove_Impl(const char *local_path); -#endif /* OS_SHARED_DIR_H */ +#endif /* OS_SHARED_DIR_H */ diff --git a/src/os/shared/inc/os-shared-errors.h b/src/os/shared/inc/os-shared-errors.h index 59cf8d21a..00f37c49b 100644 --- a/src/os/shared/inc/os-shared-errors.h +++ b/src/os/shared/inc/os-shared-errors.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-errors.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -39,4 +39,4 @@ typedef struct extern const OS_ErrorTable_Entry_t OS_IMPL_ERROR_NAME_TABLE[]; -#endif /* OS_SHARED_ERRORS_H */ +#endif /* OS_SHARED_ERRORS_H */ diff --git a/src/os/shared/inc/os-shared-file.h b/src/os/shared/inc/os-shared-file.h index a3177f2d1..4e2256c1c 100644 --- a/src/os/shared/inc/os-shared-file.h +++ b/src/os/shared/inc/os-shared-file.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-file.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -191,4 +191,4 @@ int32 OS_FileChmod_Impl(const char *local_path, uint32 access); */ int32 OS_FileIteratorClose(osal_id_t filedes, void *arg); -#endif /* OS_SHARED_FILE_H */ +#endif /* OS_SHARED_FILE_H */ diff --git a/src/os/shared/inc/os-shared-filesys.h b/src/os/shared/inc/os-shared-filesys.h index 52e3c7467..190ce4cde 100644 --- a/src/os/shared/inc/os-shared-filesys.h +++ b/src/os/shared/inc/os-shared-filesys.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-filesys.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -192,4 +192,4 @@ int32 OS_FileSys_Initialize(char *address, const char *fsdevname, const char *fs osal_blockcount_t numblocks, bool should_format); bool OS_FileSysFilterFree(void *ref, const OS_object_token_t *token, const OS_common_record_t *obj); -#endif /* OS_SHARED_FILESYS_H */ +#endif /* OS_SHARED_FILESYS_H */ diff --git a/src/os/shared/inc/os-shared-globaldefs.h b/src/os/shared/inc/os-shared-globaldefs.h index 0f604c8e3..6f391fc12 100644 --- a/src/os/shared/inc/os-shared-globaldefs.h +++ b/src/os/shared/inc/os-shared-globaldefs.h @@ -19,17 +19,17 @@ */ /** - * \file os-shared-globaldefs.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * * Internal type/macro definitions used across the "shared" OSAPI layer. * These definitions are internal to OSAL but shared/referenced across all subsystems * so they are put into a common header file. */ -#ifndef OSAPI_SHARED_GLOBALDEFS_H_ -#define OSAPI_SHARED_GLOBALDEFS_H_ +#ifndef OS_SHARED_GLOBALDEFS_H +#define OS_SHARED_GLOBALDEFS_H /* All subsystems reference the same config, common types, and other constants */ #include "osconfig.h" @@ -148,4 +148,4 @@ extern void OS_DebugPrintf(uint32 Level, const char *Func, uint32 Line, const ch */ #define OS_CHECK_PATHNAME(str) OS_CHECK_STRING(str, OS_MAX_PATH_LEN, OS_FS_ERR_PATH_TOO_LONG) -#endif /* OS_SHARED_GLOBALDEFS_H */ +#endif /* OS_SHARED_GLOBALDEFS_H */ diff --git a/src/os/shared/inc/os-shared-heap.h b/src/os/shared/inc/os-shared-heap.h index 72b786636..ca78454cf 100644 --- a/src/os/shared/inc/os-shared-heap.h +++ b/src/os/shared/inc/os-shared-heap.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-heap.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -48,4 +48,4 @@ ------------------------------------------------------------------*/ int32 OS_HeapGetInfo_Impl(OS_heap_prop_t *heap_prop); -#endif /* OS_SHARED_HEAP_H */ +#endif /* OS_SHARED_HEAP_H */ diff --git a/src/os/shared/inc/os-shared-idmap.h b/src/os/shared/inc/os-shared-idmap.h index ae798ff9b..111d4e8ff 100644 --- a/src/os/shared/inc/os-shared-idmap.h +++ b/src/os/shared/inc/os-shared-idmap.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-idmap.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -545,4 +545,4 @@ bool OS_ObjectNameMatch(void *ref, const OS_object_token_t *token, const OS_com int32 OS_ObjectIdFindNextMatch(OS_ObjectMatchFunc_t MatchFunc, void *arg, OS_object_token_t *token); int32 OS_ObjectIdFindNextFree(OS_object_token_t *token); -#endif /* OS_SHARED_IDMAP_H */ +#endif /* OS_SHARED_IDMAP_H */ diff --git a/src/os/shared/inc/os-shared-module.h b/src/os/shared/inc/os-shared-module.h index 0031b420a..86811e8e7 100644 --- a/src/os/shared/inc/os-shared-module.h +++ b/src/os/shared/inc/os-shared-module.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-module.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -130,4 +130,4 @@ int32 OS_SymbolTableDump_Impl(const char *filename, size_t size_limit); int32 OS_ModuleLoad_Static(const char *ModuleName); int32 OS_SymbolLookup_Static(cpuaddr *SymbolAddress, const char *SymbolName, const char *ModuleName); -#endif /* OS_SHARED_MODULE_H */ +#endif /* OS_SHARED_MODULE_H */ diff --git a/src/os/shared/inc/os-shared-mutex.h b/src/os/shared/inc/os-shared-mutex.h index 5ce6ed1a2..deb10589a 100644 --- a/src/os/shared/inc/os-shared-mutex.h +++ b/src/os/shared/inc/os-shared-mutex.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-mutex.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -97,4 +97,4 @@ int32 OS_MutSemDelete_Impl(const OS_object_token_t *token); ------------------------------------------------------------------*/ int32 OS_MutSemGetInfo_Impl(const OS_object_token_t *token, OS_mut_sem_prop_t *mut_prop); -#endif /* OS_SHARED_MUTEX_H */ +#endif /* OS_SHARED_MUTEX_H */ diff --git a/src/os/shared/inc/os-shared-network.h b/src/os/shared/inc/os-shared-network.h index 951c5d374..009e26053 100644 --- a/src/os/shared/inc/os-shared-network.h +++ b/src/os/shared/inc/os-shared-network.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-network.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -63,4 +63,4 @@ int32 OS_NetworkGetHostName_Impl(char *host_name, size_t name_len); ------------------------------------------------------------------*/ int32 OS_NetworkGetID_Impl(int32 *IdBuf); -#endif /* OS_SHARED_NETWORK_H */ +#endif /* OS_SHARED_NETWORK_H */ diff --git a/src/os/shared/inc/os-shared-printf.h b/src/os/shared/inc/os-shared-printf.h index 721ed3ea8..b1cce4fcc 100644 --- a/src/os/shared/inc/os-shared-printf.h +++ b/src/os/shared/inc/os-shared-printf.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-printf.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -103,4 +103,4 @@ void OS_ConsoleOutput_Impl(const OS_object_token_t *token); ------------------------------------------------------------------*/ void OS_ConsoleWakeup_Impl(const OS_object_token_t *token); -#endif /* OS_SHARED_PRINTF_H */ +#endif /* OS_SHARED_PRINTF_H */ diff --git a/src/os/shared/inc/os-shared-queue.h b/src/os/shared/inc/os-shared-queue.h index 93a303f40..bf9a4037e 100644 --- a/src/os/shared/inc/os-shared-queue.h +++ b/src/os/shared/inc/os-shared-queue.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-queue.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -107,4 +107,4 @@ int32 OS_QueuePut_Impl(const OS_object_token_t *token, const void *data, size_t ------------------------------------------------------------------*/ int32 OS_QueueGetInfo_Impl(const OS_object_token_t *token, OS_queue_prop_t *queue_prop); -#endif /* OS_SHARED_QUEUE_H */ +#endif /* OS_SHARED_QUEUE_H */ diff --git a/src/os/shared/inc/os-shared-select.h b/src/os/shared/inc/os-shared-select.h index 75cfef0c9..62072b371 100644 --- a/src/os/shared/inc/os-shared-select.h +++ b/src/os/shared/inc/os-shared-select.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-select.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -78,4 +78,4 @@ int32 OS_SelectSingle_Impl(const OS_object_token_t *token, uint32 *SelectFlags, ------------------------------------------------------------------*/ int32 OS_SelectMultiple_Impl(OS_FdSet *ReadSet, OS_FdSet *WriteSet, int32 msecs); -#endif /* OS_SHARED_SELECT_H */ +#endif /* OS_SHARED_SELECT_H */ diff --git a/src/os/shared/inc/os-shared-shell.h b/src/os/shared/inc/os-shared-shell.h index cf512ef8c..0cf38df25 100644 --- a/src/os/shared/inc/os-shared-shell.h +++ b/src/os/shared/inc/os-shared-shell.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-shell.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -44,4 +44,4 @@ ------------------------------------------------------------------*/ int32 OS_ShellOutputToFile_Impl(const OS_object_token_t *token, const char *Cmd); -#endif /* OS_SHARED_SHELL_H */ +#endif /* OS_SHARED_SHELL_H */ diff --git a/src/os/shared/inc/os-shared-sockets.h b/src/os/shared/inc/os-shared-sockets.h index 37b77ee19..7b9d96bb0 100644 --- a/src/os/shared/inc/os-shared-sockets.h +++ b/src/os/shared/inc/os-shared-sockets.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-sockets.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -180,4 +180,4 @@ int32 OS_SocketAddrSetPort_Impl(OS_SockAddr_t *Addr, uint16 PortNum); */ void OS_CreateSocketName(const OS_object_token_t *token, const OS_SockAddr_t *Addr, const char *parent_name); -#endif /* OS_SHARED_SOCKETS_H */ +#endif /* OS_SHARED_SOCKETS_H */ diff --git a/src/os/shared/inc/os-shared-task.h b/src/os/shared/inc/os-shared-task.h index 9ec7d350e..ef5addf6e 100644 --- a/src/os/shared/inc/os-shared-task.h +++ b/src/os/shared/inc/os-shared-task.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-task.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -192,4 +192,4 @@ bool OS_TaskIdMatchSystemData_Impl(void *ref, const OS_object_token_t *token, co ------------------------------------------------------------------*/ int32 OS_TaskValidateSystemData_Impl(const void *sysdata, size_t sysdata_size); -#endif /* OS_SHARED_TASK_H */ +#endif /* OS_SHARED_TASK_H */ diff --git a/src/os/shared/inc/os-shared-time.h b/src/os/shared/inc/os-shared-time.h index af5f15b81..fc960a586 100644 --- a/src/os/shared/inc/os-shared-time.h +++ b/src/os/shared/inc/os-shared-time.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-time.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -64,4 +64,4 @@ extern OS_timecb_internal_record_t OS_timecb_table[OS_MAX_TIMERS]; ---------------------------------------------------------------------------------------*/ int32 OS_TimerCbAPI_Init(void); -#endif /* OS_SHARED_TIME_H */ +#endif /* OS_SHARED_TIME_H */ diff --git a/src/os/shared/inc/os-shared-timebase.h b/src/os/shared/inc/os-shared-timebase.h index c056a8fdc..bc647e02d 100644 --- a/src/os/shared/inc/os-shared-timebase.h +++ b/src/os/shared/inc/os-shared-timebase.h @@ -19,9 +19,9 @@ */ /** - * \file os-shared-timebase.h + * \file + * * \ingroup shared - * \author joseph.p.hickey@nasa.gov * */ @@ -138,4 +138,4 @@ void OS_TimeBase_CallbackThread(osal_id_t timebase_id); ------------------------------------------------------------------*/ int32 OS_Milli2Ticks(uint32 milli_seconds, int *ticks); -#endif /* OS_SHARED_TIMEBASE_H */ +#endif /* OS_SHARED_TIMEBASE_H */ diff --git a/src/os/vxworks/inc/os-impl-binsem.h b/src/os/vxworks/inc/os-impl-binsem.h index d18aa9a61..6cbd8a934 100644 --- a/src/os/vxworks/inc/os-impl-binsem.h +++ b/src/os/vxworks/inc/os-impl-binsem.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-binsem.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -41,4 +41,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_binsem_internal_record_t OS_impl_bin_sem_table[OS_MAX_BIN_SEMAPHORES]; -#endif /* OS_IMPL_BINSEM_H */ +#endif /* OS_IMPL_BINSEM_H */ diff --git a/src/os/vxworks/inc/os-impl-console.h b/src/os/vxworks/inc/os-impl-console.h index 56d44993c..f87c9203f 100644 --- a/src/os/vxworks/inc/os-impl-console.h +++ b/src/os/vxworks/inc/os-impl-console.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-console.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -44,4 +44,4 @@ typedef struct extern OS_impl_console_internal_record_t OS_impl_console_table[OS_MAX_CONSOLES]; -#endif /* OS_IMPL_CONSOLE_H */ +#endif /* OS_IMPL_CONSOLE_H */ diff --git a/src/os/vxworks/inc/os-impl-countsem.h b/src/os/vxworks/inc/os-impl-countsem.h index 4d14393a2..ca0b6734f 100644 --- a/src/os/vxworks/inc/os-impl-countsem.h +++ b/src/os/vxworks/inc/os-impl-countsem.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-countsem.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -41,4 +41,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_countsem_internal_record_t OS_impl_count_sem_table[OS_MAX_COUNT_SEMAPHORES]; -#endif /* OS_IMPL_COUNTSEM_H */ +#endif /* OS_IMPL_COUNTSEM_H */ diff --git a/src/os/vxworks/inc/os-impl-dirs.h b/src/os/vxworks/inc/os-impl-dirs.h index 5ae902ee2..9c9343822 100644 --- a/src/os/vxworks/inc/os-impl-dirs.h +++ b/src/os/vxworks/inc/os-impl-dirs.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-dirs.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -55,4 +55,4 @@ typedef struct */ extern OS_impl_dir_internal_record_t OS_impl_dir_table[OS_MAX_NUM_OPEN_DIRS]; -#endif /* OS_IMPL_DIRS_H */ +#endif /* OS_IMPL_DIRS_H */ diff --git a/src/os/vxworks/inc/os-impl-files.h b/src/os/vxworks/inc/os-impl-files.h index 64378a043..1fac436c9 100644 --- a/src/os/vxworks/inc/os-impl-files.h +++ b/src/os/vxworks/inc/os-impl-files.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-files.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -47,4 +47,4 @@ */ #define OS_IMPL_REGULAR_FILE_FLAGS 0 -#endif /* OS_IMPL_FILES_H */ +#endif /* OS_IMPL_FILES_H */ diff --git a/src/os/vxworks/inc/os-impl-filesys.h b/src/os/vxworks/inc/os-impl-filesys.h index b376ef0fa..170c68c2c 100644 --- a/src/os/vxworks/inc/os-impl-filesys.h +++ b/src/os/vxworks/inc/os-impl-filesys.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-filesys.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -42,4 +42,4 @@ typedef struct extern OS_impl_filesys_internal_record_t OS_impl_filesys_table[OS_MAX_FILE_SYSTEMS]; -#endif /* OS_IMPL_FILESYS_H */ +#endif /* OS_IMPL_FILESYS_H */ diff --git a/src/os/vxworks/inc/os-impl-gettime.h b/src/os/vxworks/inc/os-impl-gettime.h index 5a66cabd9..4c4d829a0 100644 --- a/src/os/vxworks/inc/os-impl-gettime.h +++ b/src/os/vxworks/inc/os-impl-gettime.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-gettime.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -33,4 +33,4 @@ #define OSAL_GETTIME_SOURCE_CLOCK CLOCK_MONOTONIC -#endif /* OS_IMPL_GETTIME_H */ +#endif /* OS_IMPL_GETTIME_H */ diff --git a/src/os/vxworks/inc/os-impl-idmap.h b/src/os/vxworks/inc/os-impl-idmap.h index 2e2098a31..2aba2e22e 100644 --- a/src/os/vxworks/inc/os-impl-idmap.h +++ b/src/os/vxworks/inc/os-impl-idmap.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-idmap.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -41,4 +41,4 @@ typedef struct /* Tables where the lock state information is stored */ extern OS_impl_objtype_lock_t *const OS_impl_objtype_lock_table[OS_OBJECT_TYPE_USER]; -#endif /* OS_IMPL_IDMAP_H */ +#endif /* OS_IMPL_IDMAP_H */ diff --git a/src/os/vxworks/inc/os-impl-io.h b/src/os/vxworks/inc/os-impl-io.h index 0968588f6..94d3c2432 100644 --- a/src/os/vxworks/inc/os-impl-io.h +++ b/src/os/vxworks/inc/os-impl-io.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-io.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -55,4 +55,4 @@ extern OS_impl_file_internal_record_t OS_impl_filehandle_table[OS_MAX_NUM_OPEN_F */ #define GENERIC_IO_CONST_DATA_CAST (void *) -#endif /* OS_IMPL_IO_H */ +#endif /* OS_IMPL_IO_H */ diff --git a/src/os/vxworks/inc/os-impl-loader.h b/src/os/vxworks/inc/os-impl-loader.h index 3093c6e5d..1a4bb8a8e 100644 --- a/src/os/vxworks/inc/os-impl-loader.h +++ b/src/os/vxworks/inc/os-impl-loader.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-loader.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -51,4 +51,4 @@ typedef struct */ extern OS_impl_module_internal_record_t OS_impl_module_table[OS_MAX_MODULES]; -#endif /* OS_IMPL_LOADER_H */ +#endif /* OS_IMPL_LOADER_H */ diff --git a/src/os/vxworks/inc/os-impl-mutex.h b/src/os/vxworks/inc/os-impl-mutex.h index 08bb6b388..efc738a39 100644 --- a/src/os/vxworks/inc/os-impl-mutex.h +++ b/src/os/vxworks/inc/os-impl-mutex.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-mutex.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -40,4 +40,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_mutsem_internal_record_t OS_impl_mutex_table[OS_MAX_MUTEXES]; -#endif /* OS_IMPL_MUTEX_H */ +#endif /* OS_IMPL_MUTEX_H */ diff --git a/src/os/vxworks/inc/os-impl-network.h b/src/os/vxworks/inc/os-impl-network.h index 4b473c856..5fea50be8 100644 --- a/src/os/vxworks/inc/os-impl-network.h +++ b/src/os/vxworks/inc/os-impl-network.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-network.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -36,4 +36,4 @@ #include #include -#endif /* OS_IMPL_NETWORK_H */ +#endif /* OS_IMPL_NETWORK_H */ diff --git a/src/os/vxworks/inc/os-impl-queues.h b/src/os/vxworks/inc/os-impl-queues.h index d82a7affe..78ca2aba0 100644 --- a/src/os/vxworks/inc/os-impl-queues.h +++ b/src/os/vxworks/inc/os-impl-queues.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-queues.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -39,4 +39,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_queue_internal_record_t OS_impl_queue_table[OS_MAX_QUEUES]; -#endif /* OS_IMPL_QUEUES_H */ +#endif /* OS_IMPL_QUEUES_H */ diff --git a/src/os/vxworks/inc/os-impl-select.h b/src/os/vxworks/inc/os-impl-select.h index d29b5d8e5..1479577ff 100644 --- a/src/os/vxworks/inc/os-impl-select.h +++ b/src/os/vxworks/inc/os-impl-select.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-select.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -31,4 +31,4 @@ #include "os-impl-io.h" #include -#endif /* OS_IMPL_SELECT_H */ +#endif /* OS_IMPL_SELECT_H */ diff --git a/src/os/vxworks/inc/os-impl-sockets.h b/src/os/vxworks/inc/os-impl-sockets.h index 32dbabea2..663651bf6 100644 --- a/src/os/vxworks/inc/os-impl-sockets.h +++ b/src/os/vxworks/inc/os-impl-sockets.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-sockets.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -46,4 +46,4 @@ /* The "in.h" header file supplied in VxWorks 6.9 is missing the "in_port_t" typedef */ typedef u_short in_port_t; -#endif /* OS_IMPL_SOCKETS_H */ +#endif /* OS_IMPL_SOCKETS_H */ diff --git a/src/os/vxworks/inc/os-impl-symtab.h b/src/os/vxworks/inc/os-impl-symtab.h index 037207385..164e8206a 100644 --- a/src/os/vxworks/inc/os-impl-symtab.h +++ b/src/os/vxworks/inc/os-impl-symtab.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-symtab.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -44,4 +44,4 @@ extern SymbolDumpState_t OS_VxWorks_SymbolDumpState; BOOL OS_SymTableIterator_Impl(char *name, SYM_VALUE val, SYM_TYPE type, _Vx_usr_arg_t arg, SYM_GROUP group); -#endif /* OS_IMPL_SYMTAB_H */ +#endif /* OS_IMPL_SYMTAB_H */ diff --git a/src/os/vxworks/inc/os-impl-tasks.h b/src/os/vxworks/inc/os-impl-tasks.h index 12ef8f726..62c6bc3d9 100644 --- a/src/os/vxworks/inc/os-impl-tasks.h +++ b/src/os/vxworks/inc/os-impl-tasks.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-tasks.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -51,4 +51,4 @@ typedef struct /* Tables where the OS object information is stored */ extern OS_impl_task_internal_record_t OS_impl_task_table[OS_MAX_TASKS]; -#endif /* OS_IMPL_TASKS_H */ +#endif /* OS_IMPL_TASKS_H */ diff --git a/src/os/vxworks/inc/os-impl-timebase.h b/src/os/vxworks/inc/os-impl-timebase.h index 72dbd22ba..c9b23b21f 100644 --- a/src/os/vxworks/inc/os-impl-timebase.h +++ b/src/os/vxworks/inc/os-impl-timebase.h @@ -19,9 +19,9 @@ */ /** - * \file os-impl-timebase.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -61,4 +61,4 @@ typedef struct extern OS_impl_timebase_internal_record_t OS_impl_timebase_table[OS_MAX_TIMEBASES]; -#endif /* OS_IMPL_TIMEBASE_H */ +#endif /* OS_IMPL_TIMEBASE_H */ diff --git a/src/os/vxworks/inc/os-vxworks.h b/src/os/vxworks/inc/os-vxworks.h index 5c6cd95f0..19c23a602 100644 --- a/src/os/vxworks/inc/os-vxworks.h +++ b/src/os/vxworks/inc/os-vxworks.h @@ -19,9 +19,9 @@ */ /** - * \file os-vxworks.h + * \file + * * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov * */ @@ -82,4 +82,4 @@ int32 OS_VxWorks_GenericSemGive(SEM_ID vxid); int32 OS_VxWorks_TableMutex_Init(osal_objtype_t idtype); -#endif /* OS_VXWORKS_H */ +#endif /* OS_VXWORKS_H */ diff --git a/src/tests/osal-core-test/osal-core-test.h b/src/tests/osal-core-test/osal-core-test.h index b6c7c7099..955cc2826 100644 --- a/src/tests/osal-core-test/osal-core-test.h +++ b/src/tests/osal-core-test/osal-core-test.h @@ -18,7 +18,8 @@ * limitations under the License. */ -/* File: test.h +/** + * \file * * Purpose: * This is a simple header file used to remove a lot of the task definitions @@ -26,8 +27,8 @@ * */ -#ifndef INCLUDE_osal_core_test_h -#define INCLUDE_osal_core_test_h +#ifndef OSAL_CORE_TEST_H +#define OSAL_CORE_TEST_H /* Task 0 */ #define TASK_0_STACK_SIZE 1024 @@ -49,4 +50,4 @@ #define MSGQ_DEPTH 50 #define MSGQ_SIZE 4 -#endif /* INCLUDE_osal_core_test_h */ +#endif /* OSAL_CORE_TEST_H */ 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 index 4e7d87b09..d84459b17 100644 --- 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 joseph.p.hickey@nasa.gov + * \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 index 365cf699b..9557537fa 100644 --- 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 joseph.p.hickey@nasa.gov + * \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 index eb946dff0..0b55d175d 100644 --- 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 joseph.p.hickey@nasa.gov + * \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 index da0ce088b..690ec3901 100644 --- 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 joseph.p.hickey@nasa.gov + * \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 index 21b0a3d7d..a2efd7eab 100644 --- 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 joseph.p.hickey@nasa.gov + * \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 index d244aa10f..57964df87 100644 --- 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 index 841e81efc..e11d2f783 100644 --- 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 index 0d1098e6f..3248bb7e3 100644 --- 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 /* for correct INT_MAX, etc. */ #include /* 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 index 5348636f3..2418bfce9 100644 --- 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 index ea24e37d1..d76e3fc75 100644 --- 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 joseph.p.hickey@nasa.gov - * + * \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 index 89717782a..e25898c95 100644 --- 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 index c9d81ef55..9c67bc1cc 100644 --- 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 index b4e091fdf..45eda6f2a 100644 --- 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 index bf88e5c04..a746a8d89 100644 --- 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 index 1d3fdb3cd..47333d3ef 100644 --- 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 index 74447deb5..a5092eb50 100644 --- 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 index c7735acb9..bf3ee3717 100644 --- 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 index e13aa3083..bd8f1fade 100644 --- 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 index 738bc81e3..f8f04234d 100644 --- 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 */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_fcntl.h b/src/unit-test-coverage/ut-stubs/inc/OCS_fcntl.h index 1c9e9b398..1bf974d9c 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_fcntl.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_fcntl.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for fcntl.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for fcntl.h + */ + #ifndef OCS_FCNTL_H #define OCS_FCNTL_H @@ -81,4 +87,4 @@ extern int OCS_fcntl(int fd, int cmd, ...); extern int OCS_open(const char *file, int oflag, ...); -#endif /* OCS_FCNTL_H */ +#endif /* OCS_FCNTL_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_fenv.h b/src/unit-test-coverage/ut-stubs/inc/OCS_fenv.h index db2e4d2b7..9d35a5dce 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_fenv.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_fenv.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for fenv.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for fenv.h + */ + #ifndef OCS_FENV_H #define OCS_FENV_H @@ -36,4 +42,4 @@ /* prototypes normally declared in fenv.h */ /* ----------------------------------------- */ -#endif /* OCS_FENV_H */ +#endif /* OCS_FENV_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_float.h b/src/unit-test-coverage/ut-stubs/inc/OCS_float.h index 42fe246c7..c515c25c1 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_float.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_float.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for float.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for float.h + */ + #ifndef OCS_FLOAT_H #define OCS_FLOAT_H @@ -36,4 +42,4 @@ /* prototypes normally declared in float.h */ /* ----------------------------------------- */ -#endif /* OCS_FLOAT_H */ +#endif /* OCS_FLOAT_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_hostLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_hostLib.h index 91c6468c9..7049a8b5c 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_hostLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_hostLib.h @@ -19,10 +19,10 @@ */ /** - * \file OCS_hostLib.h - * \ingroup ut-stubs - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup ut-stubs * + * Declarations and prototypes for OCS_hostLib */ #ifndef OCS_HOSTLIB_H @@ -44,4 +44,4 @@ /* ----------------------------------------- */ extern int OCS_hostGetByName(char *name); -#endif /* OCS_HOSTLIB_H */ +#endif /* OCS_HOSTLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_intLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_intLib.h index adf610020..a5642543d 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_intLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_intLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for intLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for intLib.h + */ + #ifndef OCS_INTLIB_H #define OCS_INTLIB_H @@ -44,4 +50,4 @@ extern int OCS_intLock(void); extern int OCS_intUnlock(int lockKey); extern OCS_VOIDFUNCPTR *OCS_INUM_TO_IVEC(unsigned int ui); -#endif /* OCS_INTLIB_H */ +#endif /* OCS_INTLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_inttypes.h b/src/unit-test-coverage/ut-stubs/inc/OCS_inttypes.h index f463e35bd..4fe3ae1f6 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_inttypes.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_inttypes.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for inttypes.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for inttypes.h + */ + #ifndef OCS_INTTYPES_H #define OCS_INTTYPES_H @@ -36,4 +42,4 @@ /* prototypes normally declared in inttypes.h */ /* ----------------------------------------- */ -#endif /* OCS_INTTYPES_H */ +#endif /* OCS_INTTYPES_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_ioLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_ioLib.h index 4b586b558..f864eb8a4 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_ioLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_ioLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for ioLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for ioLib.h + */ + #ifndef OCS_IOLIB_H #define OCS_IOLIB_H @@ -42,4 +48,4 @@ extern int OCS_ioctl(int fd, unsigned long request, ...); -#endif /* OCS_IOLIB_H */ +#endif /* OCS_IOLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_iv.h b/src/unit-test-coverage/ut-stubs/inc/OCS_iv.h index 686331dc2..fdedd0ec1 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_iv.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_iv.h @@ -18,10 +18,16 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for iv.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for iv.h + */ + #ifndef OCS_IV_H #define OCS_IV_H #include "OCS_basetypes.h" -#endif /* OCS_IV_H */ +#endif /* OCS_IV_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_loadLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_loadLib.h index 62ed85a88..6777a577b 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_loadLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_loadLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for loadLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for loadLib.h + */ + #ifndef OCS_LOADLIB_H #define OCS_LOADLIB_H @@ -40,4 +46,4 @@ extern OCS_MODULE_ID OCS_loadModule(int fd, unsigned int symFlag); -#endif /* OCS_LOADLIB_H */ +#endif /* OCS_LOADLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_locale.h b/src/unit-test-coverage/ut-stubs/inc/OCS_locale.h index 798113d67..c67366830 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_locale.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_locale.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for locale.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for locale.h + */ + #ifndef OCS_LOCALE_H #define OCS_LOCALE_H @@ -36,4 +42,4 @@ /* prototypes normally declared in locale.h */ /* ----------------------------------------- */ -#endif /* OCS_LOCALE_H */ +#endif /* OCS_LOCALE_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_logLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_logLib.h index 192d96b9b..567545d35 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_logLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_logLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for logLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for logLib.h + */ + #ifndef OCS_LOGLIB_H #define OCS_LOGLIB_H @@ -37,4 +43,4 @@ /* prototypes normally declared in logLib.h */ /* ----------------------------------------- */ -#endif /* OCS_LOGLIB_H */ +#endif /* OCS_LOGLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_math.h b/src/unit-test-coverage/ut-stubs/inc/OCS_math.h index cf75ca7b3..9e986adb9 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_math.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_math.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for math.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for math.h + */ + #ifndef OCS_MATH_H #define OCS_MATH_H @@ -36,4 +42,4 @@ /* prototypes normally declared in math.h */ /* ----------------------------------------- */ -#endif /* OCS_MATH_H */ +#endif /* OCS_MATH_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_memPartLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_memPartLib.h index 46c23f726..2c390d41b 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_memPartLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_memPartLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for memPartLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for memPartLib.h + */ + #ifndef OCS_MEMPARTLIB_H #define OCS_MEMPARTLIB_H @@ -54,4 +60,4 @@ extern OCS_STATUS OCS_memPartInfoGet(OCS_PART_ID partId, /* partition ID extern OCS_PART_ID OCS_memSysPartId; -#endif /* OCS_MEMPARTLIB_H */ +#endif /* OCS_MEMPARTLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_moduleLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_moduleLib.h index a2c634a6a..3e6f4097c 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_moduleLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_moduleLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for moduleLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for moduleLib.h + */ + #ifndef OCS_MODULELIB_H #define OCS_MODULELIB_H @@ -58,4 +64,4 @@ typedef struct OCS_MODULE_INFO extern OCS_STATUS OCS_moduleInfoGet(OCS_MODULE_ID moduleId, OCS_MODULE_INFO *pModuleInfo); -#endif /* OCS_MODULELIB_H */ +#endif /* OCS_MODULELIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_mqueue.h b/src/unit-test-coverage/ut-stubs/inc/OCS_mqueue.h index 412384931..2db252260 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_mqueue.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_mqueue.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for mqueue.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for mqueue.h + */ + #ifndef OCS_MQUEUE_H #define OCS_MQUEUE_H @@ -55,4 +61,4 @@ extern int OCS_mq_timedsend(OCS_mqd_t mqdes, const char *msg_ptr, size_t const struct OCS_timespec *abs_timeout); extern int OCS_mq_unlink(const char *name); -#endif /* OCS_MQUEUE_H */ +#endif /* OCS_MQUEUE_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_msgQLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_msgQLib.h index e9c94ec7b..f430852ed 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_msgQLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_msgQLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for msgQLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for msgQLib.h + */ + #ifndef OCS_MSGQLIB_H #define OCS_MSGQLIB_H @@ -54,4 +60,4 @@ extern OCS_STATUS OCS_msgQDelete(OCS_MSG_Q_ID msgQId); extern int OCS_msgQReceive(OCS_MSG_Q_ID msgQId, char *buffer, OCS_UINT maxNBytes, int timeout); extern OCS_STATUS OCS_msgQSend(OCS_MSG_Q_ID msgQId, char *buffer, OCS_UINT nBytes, int timeout, int priority); -#endif /* OCS_MSGQLIB_H */ +#endif /* OCS_MSGQLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_net_if.h b/src/unit-test-coverage/ut-stubs/inc/OCS_net_if.h index ed4fca017..26cf2810b 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_net_if.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_net_if.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for net/if.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for net/if.h + */ + #ifndef OCS_NET_IF_H #define OCS_NET_IF_H @@ -36,4 +42,4 @@ /* prototypes normally declared in net/if.h */ /* ----------------------------------------- */ -#endif /* OCS_NET_IF_H */ +#endif /* OCS_NET_IF_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_netdb.h b/src/unit-test-coverage/ut-stubs/inc/OCS_netdb.h index ffd623ec4..e5a9d554d 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_netdb.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_netdb.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for netdb.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for netdb.h + */ + #ifndef OCS_NETDB_H #define OCS_NETDB_H @@ -36,4 +42,4 @@ /* prototypes normally declared in netdb.h */ /* ----------------------------------------- */ -#endif /* OCS_NETDB_H */ +#endif /* OCS_NETDB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_netinet_in.h b/src/unit-test-coverage/ut-stubs/inc/OCS_netinet_in.h index efbc3333e..7e37be61c 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_netinet_in.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_netinet_in.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for netinet/in.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for netinet/in.h + */ + #ifndef OCS_NETINET_IN_H #define OCS_NETINET_IN_H @@ -41,4 +47,4 @@ extern uint16_t OCS_ntohs(uint16_t netshort); extern uint32_t OCS_htonl(uint32_t hostlong); extern uint32_t OCS_ntohl(uint32_t netlong); -#endif /* OCS_NETINET_IN_H */ +#endif /* OCS_NETINET_IN_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_netinet_tcp.h b/src/unit-test-coverage/ut-stubs/inc/OCS_netinet_tcp.h index 7f4349b4e..aedfaeb17 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_netinet_tcp.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_netinet_tcp.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for netinet/tcp.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for netinet/tcp.h + */ + #ifndef OCS_NETINET_TCP_H #define OCS_NETINET_TCP_H @@ -36,4 +42,4 @@ /* prototypes normally declared in netinet/tcp.h */ /* ----------------------------------------- */ -#endif /* OCS_NETINET_TCP_H */ +#endif /* OCS_NETINET_TCP_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_objLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_objLib.h index 8c9f45c30..201c724c4 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_objLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_objLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for objLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for objLib.h + */ + #ifndef OCS_OBJLIB_H #define OCS_OBJLIB_H @@ -44,4 +50,4 @@ /* prototypes normally declared in objLib.h */ /* ----------------------------------------- */ -#endif /* OCS_OBJLIB_H */ +#endif /* OCS_OBJLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_poll.h b/src/unit-test-coverage/ut-stubs/inc/OCS_poll.h index 1bff813f6..e08c14cbb 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_poll.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_poll.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for poll.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for poll.h + */ + #ifndef OCS_POLL_H #define OCS_POLL_H @@ -36,4 +42,4 @@ /* prototypes normally declared in poll.h */ /* ----------------------------------------- */ -#endif /* OCS_POLL_H */ +#endif /* OCS_POLL_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_pthread.h b/src/unit-test-coverage/ut-stubs/inc/OCS_pthread.h index 359c60556..89b5b36e8 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_pthread.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_pthread.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for pthread.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for pthread.h + */ + #ifndef OCS_PTHREAD_H #define OCS_PTHREAD_H @@ -122,4 +128,4 @@ extern int OCS_pthread_setschedprio(OCS_pthread_t target_thread, int prio); extern int OCS_pthread_setspecific(OCS_pthread_key_t key, const void *pointer); extern int OCS_pthread_sigmask(int how, const OCS_sigset_t *set, OCS_sigset_t *oldset); -#endif /* OCS_PTHREAD_H */ +#endif /* OCS_PTHREAD_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_ramDiskCbio.h b/src/unit-test-coverage/ut-stubs/inc/OCS_ramDiskCbio.h index d57f9c58c..8512a8f24 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_ramDiskCbio.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_ramDiskCbio.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for ramDiskCbio.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for ramDiskCbio.h + */ + #ifndef OCS_RAMDISKCBIO_H #define OCS_RAMDISKCBIO_H @@ -37,4 +43,4 @@ /* prototypes normally declared in ramDiskCbio.h */ /* ----------------------------------------- */ -#endif /* OCS_RAMDISKCBIO_H */ +#endif /* OCS_RAMDISKCBIO_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_ramDrv.h b/src/unit-test-coverage/ut-stubs/inc/OCS_ramDrv.h index 464114023..e83c7f758 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_ramDrv.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_ramDrv.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for ramDrv.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for ramDrv.h + */ + #ifndef OCS_RAMDRV_H #define OCS_RAMDRV_H @@ -39,4 +45,4 @@ /* ----------------------------------------- */ extern OCS_BLK_DEV *OCS_ramDevCreate(char *ramAddr, int bytesPerSec, int secPerTrack, int nSectors, int secOffset); -#endif /* OCS_RAMDRV_H */ +#endif /* OCS_RAMDRV_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sched.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sched.h index 3bdfadc54..a0e5a3cea 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sched.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sched.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sched.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sched.h + */ + #ifndef OCS_SCHED_H #define OCS_SCHED_H @@ -45,4 +51,4 @@ struct OCS_sched_param extern int OCS_sched_get_priority_max(int policy); extern int OCS_sched_get_priority_min(int policy); -#endif /* OCS_SCHED_H */ +#endif /* OCS_SCHED_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_semLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_semLib.h index d8979720b..463615e08 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_semLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_semLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for semLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for semLib.h + */ + #ifndef OCS_SEMLIB_H #define OCS_SEMLIB_H @@ -70,4 +76,4 @@ extern OCS_STATUS OCS_semFlush(OCS_SEM_ID semId); extern OCS_STATUS OCS_semTake(OCS_SEM_ID semId, int timeout); extern OCS_STATUS OCS_semGive(OCS_SEM_ID semId); -#endif /* OCS_SEMLIB_H */ +#endif /* OCS_SEMLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_semaphore.h b/src/unit-test-coverage/ut-stubs/inc/OCS_semaphore.h index d09c76dd2..afe030554 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_semaphore.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_semaphore.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for semaphore.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for semaphore.h + */ + #ifndef OCS_SEMAPHORE_H #define OCS_SEMAPHORE_H @@ -49,4 +55,4 @@ extern int OCS_sem_post(OCS_sem_t *sem); extern int OCS_sem_timedwait(OCS_sem_t *sem, const struct OCS_timespec *abstime); extern int OCS_sem_wait(OCS_sem_t *sem); -#endif /* OCS_SEMAPHORE_H */ +#endif /* OCS_SEMAPHORE_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_setjmp.h b/src/unit-test-coverage/ut-stubs/inc/OCS_setjmp.h index 516dff5ce..f512b145e 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_setjmp.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_setjmp.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for setjmp.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for setjmp.h + */ + #ifndef OCS_SETJMP_H #define OCS_SETJMP_H @@ -36,4 +42,4 @@ /* prototypes normally declared in setjmp.h */ /* ----------------------------------------- */ -#endif /* OCS_SETJMP_H */ +#endif /* OCS_SETJMP_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_shellLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_shellLib.h index 9a4ed1f0d..2f4fe3b5a 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_shellLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_shellLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for shellLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for shellLib.h + */ + #ifndef OCS_SHELLLIB_H #define OCS_SHELLLIB_H @@ -40,4 +46,4 @@ extern OCS_STATUS OCS_shellGenericInit(const char *config, int stackSize, const char *shellName, char **pShellName, OCS_BOOL interactive, OCS_BOOL loginAccess, int fdin, int fdout, int fderr); -#endif /* OCS_SHELLLIB_H */ +#endif /* OCS_SHELLLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_signal.h b/src/unit-test-coverage/ut-stubs/inc/OCS_signal.h index 0fde69fc3..815c417a8 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_signal.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_signal.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for signal.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for signal.h + */ + #ifndef OCS_SIGNAL_H #define OCS_SIGNAL_H @@ -74,4 +80,4 @@ extern int OCS_sigprocmask(int how, const OCS_sigset_t *set, OCS_si extern int OCS_sigsuspend(const OCS_sigset_t *set); extern int OCS_sigwait(const OCS_sigset_t *set, int *sig); -#endif /* OCS_SIGNAL_H */ +#endif /* OCS_SIGNAL_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_stat.h b/src/unit-test-coverage/ut-stubs/inc/OCS_stat.h index 92ec7b06c..a4414aa41 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_stat.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_stat.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for stat.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for stat.h + */ + #ifndef OCS_STAT_H #define OCS_STAT_H @@ -74,4 +80,4 @@ extern int OCS_fstat(int fd, struct OCS_stat *buf); extern int OCS_statvfs(const char *file, struct OCS_statvfs *buf); -#endif /* OCS_STAT_H */ +#endif /* OCS_STAT_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_stdarg.h b/src/unit-test-coverage/ut-stubs/inc/OCS_stdarg.h index 253786b3d..af416e7b2 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_stdarg.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_stdarg.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for stdarg.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for stdarg.h + */ + #ifndef OCS_STDARG_H #define OCS_STDARG_H @@ -43,4 +49,4 @@ typedef struct #define OCS_va_start(ap, last) ap.p = &last #define OCS_va_end(ap) -#endif /* OCS_STDARG_H */ +#endif /* OCS_STDARG_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_stdio.h b/src/unit-test-coverage/ut-stubs/inc/OCS_stdio.h index 9a7cb08fa..69bc56755 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_stdio.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_stdio.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for stdio.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for stdio.h + */ + #ifndef OCS_STDIO_H #define OCS_STDIO_H @@ -54,4 +60,4 @@ extern OCS_FILE *OCS_stdin; extern OCS_FILE *OCS_stdout; extern OCS_FILE *OCS_stderr; -#endif /* OCS_STDIO_H */ +#endif /* OCS_STDIO_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_stdlib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_stdlib.h index 9748fbda9..3e2965b99 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_stdlib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_stdlib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for stdlib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for stdlib.h + */ + #ifndef OCS_STDLIB_H #define OCS_STDLIB_H @@ -46,4 +52,4 @@ extern int OCS_system(const char *command); extern void * OCS_malloc(size_t sz); extern void OCS_free(void *ptr); -#endif /* OCS_STDLIB_H */ +#endif /* OCS_STDLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_string.h b/src/unit-test-coverage/ut-stubs/inc/OCS_string.h index c0efa0f96..c2b0bb4c2 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_string.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_string.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for string.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for string.h + */ + #ifndef OCS_STRING_H #define OCS_STRING_H @@ -50,4 +56,4 @@ extern char * OCS_strcat(char *dest, const char *src); extern char * OCS_strncat(char *dest, const char *src, size_t n); extern char * OCS_strerror(int errnum); -#endif /* OCS_STRING_H */ +#endif /* OCS_STRING_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_strings.h b/src/unit-test-coverage/ut-stubs/inc/OCS_strings.h index 90cd12424..9287c3df1 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_strings.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_strings.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for strings.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for strings.h + */ + #ifndef OCS_STRINGS_H #define OCS_STRINGS_H @@ -36,4 +42,4 @@ /* prototypes normally declared in strings.h */ /* ----------------------------------------- */ -#endif /* OCS_STRINGS_H */ +#endif /* OCS_STRINGS_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_symLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_symLib.h index 4d5b3ab40..b029d9231 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_symLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_symLib.h @@ -19,9 +19,8 @@ */ /** - * \file OCS_symLib.h - * \ingroup ut-stubs - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup ut-stubs * * OSAL coverage stub replacement for symLib.h */ @@ -70,4 +69,4 @@ extern OCS_STATUS OCS_symFindByName(OCS_SYMTAB_ID symTblId, char *name, char ** extern OCS_SYMBOL *OCS_symEach(OCS_SYMTAB_ID symTblId, OCS_symEach_Routine_t routine, int routineArg); extern OCS_STATUS OCS_symFind(OCS_SYMTAB_ID symTblId, OCS_SYMBOL_DESC *pSymbol); -#endif /* OCS_SYMLIB_H */ +#endif /* OCS_SYMLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sysLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sysLib.h index 4ab7399ee..bfabef420 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sysLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sysLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sysLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sysLib.h + */ + #ifndef OCS_SYSLIB_H #define OCS_SYSLIB_H @@ -38,4 +44,4 @@ /* ----------------------------------------- */ extern int OCS_sysClkRateGet(void); -#endif /* OCS_SYSLIB_H */ +#endif /* OCS_SYSLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_ioctl.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_ioctl.h index 3c28cfdd4..65158477c 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_ioctl.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_ioctl.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/ioctl.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/ioctl.h + */ + #ifndef OCS_SYS_IOCTL_H #define OCS_SYS_IOCTL_H @@ -38,4 +44,4 @@ extern int OCS_ioctl(int fd, unsigned long request, ...); -#endif /* OCS_SYS_IOCTL_H */ +#endif /* OCS_SYS_IOCTL_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_ipc.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_ipc.h index cdc2ee19a..b20ba77bd 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_ipc.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_ipc.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/ipc.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/ipc.h + */ + #ifndef OCS_SYS_IPC_H #define OCS_SYS_IPC_H @@ -36,4 +42,4 @@ /* prototypes normally declared in sys/ipc.h */ /* ----------------------------------------- */ -#endif /* OCS_SYS_IPC_H */ +#endif /* OCS_SYS_IPC_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_mman.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_mman.h index 754dd358b..483458887 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_mman.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_mman.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/mman.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/mman.h + */ + #ifndef OCS_SYS_MMAN_H #define OCS_SYS_MMAN_H @@ -45,4 +51,4 @@ void *OCS_mmap(void *addr, size_t length, int prot, int flags, int fd, OCS_off_t offset); int OCS_munmap(void *addr, size_t length); -#endif /* OCS_SYS_MMAN_H */ +#endif /* OCS_SYS_MMAN_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_select.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_select.h index 57098ca23..3fb64e403 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_select.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_select.h @@ -19,10 +19,10 @@ */ /** - * \file OCS_sys_select.h - * \ingroup ut-stubs - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup ut-stubs * + * Declarations and prototypes for OCS_sys_select */ #ifndef OCS_SYS_SELECT_H @@ -57,4 +57,4 @@ extern int OCS_FD_ISSET(int fd, OCS_fd_set *set); extern void OCS_FD_CLR(int fd, OCS_fd_set *set); extern void OCS_FD_ZERO(OCS_fd_set *set); -#endif /* OCS_SYS_SELECT_H */ +#endif /* OCS_SYS_SELECT_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_socket.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_socket.h index 521903731..49cb05f9d 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_socket.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_socket.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/socket.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/socket.h + */ + #ifndef OCS_SYS_SOCKET_H #define OCS_SYS_SOCKET_H @@ -86,4 +92,4 @@ extern OCS_ssize_t OCS_sendto(int fd, const void *buf, size_t n, int flags, cons extern int OCS_setsockopt(int fd, int level, int optname, const void *optval, OCS_socklen_t optlen); extern int OCS_socket(int domain, int type, int protocol); -#endif /* OCS_SYS_SOCKET_H */ +#endif /* OCS_SYS_SOCKET_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_time.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_time.h index b757f758f..48557de8d 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_time.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_time.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/time.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/time.h + */ + #ifndef OCS_SYS_TIME_H #define OCS_SYS_TIME_H @@ -37,4 +43,4 @@ /* prototypes normally declared in sys/time.h */ /* ----------------------------------------- */ -#endif /* OCS_SYS_TIME_H */ +#endif /* OCS_SYS_TIME_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_times.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_times.h index 7ae0e2e86..9f4e72517 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_times.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_times.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/times.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/times.h + */ + #ifndef OCS_SYS_TIMES_H #define OCS_SYS_TIMES_H @@ -37,4 +43,4 @@ /* prototypes normally declared in sys/times.h */ /* ----------------------------------------- */ -#endif /* OCS_SYS_TIMES_H */ +#endif /* OCS_SYS_TIMES_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_types.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_types.h index 196f3ca83..05281c203 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_types.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_types.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/types.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/types.h + */ + #ifndef OCS_SYS_TYPES_H #define OCS_SYS_TYPES_H @@ -44,4 +50,4 @@ typedef unsigned short int OCS_u_short; /* prototypes normally declared in sys/types.h */ /* ----------------------------------------- */ -#endif /* OCS_SYS_TYPES_H */ +#endif /* OCS_SYS_TYPES_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_un.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_un.h index 558e02dfb..21a9ca3ab 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_un.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_un.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/un.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/un.h + */ + #ifndef OCS_SYS_UN_H #define OCS_SYS_UN_H @@ -36,4 +42,4 @@ /* prototypes normally declared in sys/un.h */ /* ----------------------------------------- */ -#endif /* OCS_SYS_UN_H */ +#endif /* OCS_SYS_UN_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_wait.h b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_wait.h index 10627de5d..f2dfeeb1b 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_sys_wait.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_sys_wait.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/wait.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/wait.h + */ + #ifndef OCS_SYS_WAIT_H #define OCS_SYS_WAIT_H @@ -36,4 +42,4 @@ /* prototypes normally declared in sys/wait.h */ /* ----------------------------------------- */ -#endif /* OCS_SYS_WAIT_H */ +#endif /* OCS_SYS_WAIT_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_taskLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_taskLib.h index 3e756dad6..ad6cfbcb8 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_taskLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_taskLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for taskLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for taskLib.h + */ + #ifndef OCS_TASKLIB_H #define OCS_TASKLIB_H @@ -79,4 +85,4 @@ OCS_STATUS OCS_taskInit(OCS_WIND_TCB *pTcb, char *name, int priority, int option OCS_WIND_TCB *OCS_taskTcb(OCS_TASK_ID tid); -#endif /* OCS_TASKLIB_H */ +#endif /* OCS_TASKLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_taskVarLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_taskVarLib.h index 814eaf4be..e3f4f5b42 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_taskVarLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_taskVarLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for taskVarLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for taskVarLib.h + */ + #ifndef OCS_TASKVARLIB_H #define OCS_TASKVARLIB_H @@ -39,4 +45,4 @@ extern OCS_STATUS OCS_taskVarAdd(int tid, int *pVar); -#endif /* OCS_TASKVARLIB_H */ +#endif /* OCS_TASKVARLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_termios.h b/src/unit-test-coverage/ut-stubs/inc/OCS_termios.h index 13960a7c5..77d84c87a 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_termios.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_termios.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for termios.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for termios.h + */ + #ifndef OCS_TERMIOS_H #define OCS_TERMIOS_H @@ -36,4 +42,4 @@ /* prototypes normally declared in termios.h */ /* ----------------------------------------- */ -#endif /* OCS_TERMIOS_H */ +#endif /* OCS_TERMIOS_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_tgmath.h b/src/unit-test-coverage/ut-stubs/inc/OCS_tgmath.h index fcf5c453c..48d5406e6 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_tgmath.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_tgmath.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for tgmath.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for tgmath.h + */ + #ifndef OCS_TGMATH_H #define OCS_TGMATH_H @@ -36,4 +42,4 @@ /* prototypes normally declared in tgmath.h */ /* ----------------------------------------- */ -#endif /* OCS_TGMATH_H */ +#endif /* OCS_TGMATH_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_time.h b/src/unit-test-coverage/ut-stubs/inc/OCS_time.h index 53ecd6317..1b23338d3 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_time.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_time.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for time.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for time.h + */ + #ifndef OCS_TIME_H #define OCS_TIME_H @@ -79,4 +85,4 @@ extern int OCS_timer_settime(OCS_timer_t timerid, int flags, const struct OCS_it extern int OCS_timer_connect(OCS_timer_t timerid, OCS_TIMER_CONNECT_FUNC func, int arg); -#endif /* OCS_TIME_H */ +#endif /* OCS_TIME_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_timers.h b/src/unit-test-coverage/ut-stubs/inc/OCS_timers.h index c8c206fc9..939ee2bfb 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_timers.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_timers.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for timers.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for timers.h + */ + #ifndef OCS_TIMERS_H #define OCS_TIMERS_H @@ -36,4 +42,4 @@ /* prototypes normally declared in timers.h */ /* ----------------------------------------- */ -#endif /* OCS_TIMERS_H */ +#endif /* OCS_TIMERS_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_ulimit.h b/src/unit-test-coverage/ut-stubs/inc/OCS_ulimit.h index 5d4dbb487..7ceb1296a 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_ulimit.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_ulimit.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for ulimit.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for ulimit.h + */ + #ifndef OCS_ULIMIT_H #define OCS_ULIMIT_H @@ -37,4 +43,4 @@ /* ----------------------------------------- */ long OCS_ulimit(int cmd, long newlimit); -#endif /* OCS_ULIMIT_H */ +#endif /* OCS_ULIMIT_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_unistd.h b/src/unit-test-coverage/ut-stubs/inc/OCS_unistd.h index cbcd050ea..d1e8e9d45 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_unistd.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_unistd.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for unistd.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for unistd.h + */ + #ifndef OCS_UNISTD_H #define OCS_UNISTD_H @@ -56,4 +62,4 @@ extern int OCS_rmdir(const char *path); extern long int OCS_sysconf(int name); extern OCS_ssize_t OCS_write(int fd, const void *buf, size_t n); -#endif /* OCS_UNISTD_H */ +#endif /* OCS_UNISTD_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_unldLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_unldLib.h index b5ada061f..4cb080e21 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_unldLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_unldLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for unldLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for unldLib.h + */ + #ifndef OCS_UNLDLIB_H #define OCS_UNLDLIB_H @@ -39,4 +45,4 @@ /* ----------------------------------------- */ extern OCS_STATUS OCS_unldByModuleId(OCS_MODULE_ID moduleId, int options); -#endif /* OCS_UNLDLIB_H */ +#endif /* OCS_UNLDLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_usrLib.h b/src/unit-test-coverage/ut-stubs/inc/OCS_usrLib.h index d2bdf595d..62f79c773 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_usrLib.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_usrLib.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for usrLib.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for usrLib.h + */ + #ifndef OCS_USRLIB_H #define OCS_USRLIB_H @@ -37,4 +43,4 @@ /* prototypes normally declared in usrLib.h */ /* ----------------------------------------- */ -#endif /* OCS_USRLIB_H */ +#endif /* OCS_USRLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_version.h b/src/unit-test-coverage/ut-stubs/inc/OCS_version.h index c3ac91757..3128f2079 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_version.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_version.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for version.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for version.h + */ + #ifndef OCS_VERSION_H #define OCS_VERSION_H @@ -36,4 +42,4 @@ /* prototypes normally declared in version.h */ /* ----------------------------------------- */ -#endif /* OCS_VERSION_H */ +#endif /* OCS_VERSION_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h b/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h index 534e22204..fd5e56ae7 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h @@ -19,9 +19,9 @@ */ /** - * \file OCS_vxWorks.h - * \ingroup ut-stubs - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup ut-stubs + * * OSAL coverage stub replacement for vxWorks.h */ @@ -76,4 +76,4 @@ typedef void (*OCS_VOIDFUNCPTR)(void); /* prototypes normally declared in vxWorks.h */ /* ----------------------------------------- */ -#endif /* OCS_VXWORKS_H */ +#endif /* OCS_VXWORKS_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_wchar.h b/src/unit-test-coverage/ut-stubs/inc/OCS_wchar.h index 44c5c5674..862527f23 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_wchar.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_wchar.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for wchar.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for wchar.h + */ + #ifndef OCS_WCHAR_H #define OCS_WCHAR_H @@ -36,4 +42,4 @@ /* prototypes normally declared in wchar.h */ /* ----------------------------------------- */ -#endif /* OCS_WCHAR_H */ +#endif /* OCS_WCHAR_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_wctype.h b/src/unit-test-coverage/ut-stubs/inc/OCS_wctype.h index 10ea52963..61bdd16ab 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_wctype.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_wctype.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for wctype.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for wctype.h + */ + #ifndef OCS_WCTYPE_H #define OCS_WCTYPE_H @@ -36,4 +42,4 @@ /* prototypes normally declared in wctype.h */ /* ----------------------------------------- */ -#endif /* OCS_WCTYPE_H */ +#endif /* OCS_WCTYPE_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_xbdBlkDev.h b/src/unit-test-coverage/ut-stubs/inc/OCS_xbdBlkDev.h index 99a013562..9c5cf2dc1 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_xbdBlkDev.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_xbdBlkDev.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for xbdBlkDev.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for xbdBlkDev.h + */ + #ifndef OCS_XBDBLKDEV_H #define OCS_XBDBLKDEV_H @@ -42,4 +48,4 @@ typedef int OCS_device_t; extern OCS_device_t OCS_xbdBlkDevCreateSync(OCS_BLK_DEV *bd, const char *name); extern OCS_STATUS OCS_xbdBlkDevDelete(OCS_device_t dev, OCS_BLK_DEV **ppbd); -#endif /* OCS_XBDBLKDEV_H */ +#endif /* OCS_XBDBLKDEV_H */ diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_xbdRamDisk.h b/src/unit-test-coverage/ut-stubs/inc/OCS_xbdRamDisk.h index 1ddaf05e2..a6e371994 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_xbdRamDisk.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_xbdRamDisk.h @@ -18,7 +18,13 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for xbdRamDisk.h */ +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for xbdRamDisk.h + */ + #ifndef OCS_XBDRAMDISK_H #define OCS_XBDRAMDISK_H @@ -37,4 +43,4 @@ /* prototypes normally declared in xbdRamDisk.h */ /* ----------------------------------------- */ -#endif /* OCS_XBDRAMDISK_H */ +#endif /* OCS_XBDRAMDISK_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/arpa/inet.h b/src/unit-test-coverage/ut-stubs/override_inc/arpa/inet.h index 91b93545c..3a2826092 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/arpa/inet.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/arpa/inet.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for arpa/inet.h */ -#ifndef OSAL_OVERRIDE_ARPA_INET_H -#define OSAL_OVERRIDE_ARPA_INET_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for arpa/inet.h + */ + +#ifndef OVERRIDE_ARPA_INET_H +#define OVERRIDE_ARPA_INET_H #include "OCS_arpa_inet.h" @@ -30,4 +36,4 @@ #define inet_ntop OCS_inet_ntop #define inet_pton OCS_inet_pton -#endif /* OSAL_OVERRIDE_ARPA_INET_H */ +#endif /* OVERRIDE_ARPA_INET_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/assert.h b/src/unit-test-coverage/ut-stubs/override_inc/assert.h index 083898254..b2cd17850 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/assert.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/assert.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for assert.h */ -#ifndef OSAL_OVERRIDE_ASSERT_H -#define OSAL_OVERRIDE_ASSERT_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for assert.h + */ + +#ifndef OVERRIDE_ASSERT_H +#define OVERRIDE_ASSERT_H #include "OCS_assert.h" @@ -30,4 +36,4 @@ #define assert OCS_assert -#endif /* OSAL_OVERRIDE_ASSERT_H */ +#endif /* OVERRIDE_ASSERT_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/blkIo.h b/src/unit-test-coverage/ut-stubs/override_inc/blkIo.h index 981a005b2..dcad37c95 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/blkIo.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/blkIo.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for blkIo.h */ -#ifndef OSAL_OVERRIDE_BLKIO_H -#define OSAL_OVERRIDE_BLKIO_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for blkIo.h + */ + +#ifndef OVERRIDE_BLKIO_H +#define OVERRIDE_BLKIO_H #include "OCS_blkIo.h" #include @@ -32,4 +38,4 @@ #define BLK_DEV OCS_BLK_DEV #define BLK_DEV_ID OCS_BLK_DEV_ID -#endif /* OSAL_OVERRIDE_BLKIO_H */ +#endif /* OVERRIDE_BLKIO_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/bsp-impl.h b/src/unit-test-coverage/ut-stubs/override_inc/bsp-impl.h index 1bde70096..74d7d6039 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/bsp-impl.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/bsp-impl.h @@ -19,14 +19,14 @@ */ /** - * \file bsp-impl.h - * \ingroup ut-stubs - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup ut-stubs * + * Declarations and prototypes for bsp-impl */ -#ifndef BSP_IMPL_H -#define BSP_IMPL_H +#ifndef OVERRIDE_BSP_IMPL_H +#define OVERRIDE_BSP_IMPL_H #include "OCS_bsp-impl.h" @@ -43,4 +43,4 @@ END bsp-impl.h *********************/ -#endif /* BSP_IMPL_H */ +#endif /* OVERRIDE_BSP_IMPL_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/cbioLib.h b/src/unit-test-coverage/ut-stubs/override_inc/cbioLib.h index 4b6a44c74..14555ce5d 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/cbioLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/cbioLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for cbioLib.h */ -#ifndef OSAL_OVERRIDE_CBIOLIB_H -#define OSAL_OVERRIDE_CBIOLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for cbioLib.h + */ + +#ifndef OVERRIDE_CBIOLIB_H +#define OVERRIDE_CBIOLIB_H #include "OCS_cbioLib.h" @@ -28,4 +34,4 @@ /* mappings for declarations in cbioLib.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_CBIOLIB_H */ +#endif /* OVERRIDE_CBIOLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/complex.h b/src/unit-test-coverage/ut-stubs/override_inc/complex.h index fd7267ea4..3b79e8b55 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/complex.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/complex.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for complex.h */ -#ifndef OSAL_OVERRIDE_COMPLEX_H -#define OSAL_OVERRIDE_COMPLEX_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for complex.h + */ + +#ifndef OVERRIDE_COMPLEX_H +#define OVERRIDE_COMPLEX_H #include "OCS_complex.h" @@ -28,4 +34,4 @@ /* mappings for declarations in complex.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_COMPLEX_H */ +#endif /* OVERRIDE_COMPLEX_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/ctype.h b/src/unit-test-coverage/ut-stubs/override_inc/ctype.h index 9842be2ed..c9d341d25 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/ctype.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/ctype.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for ctype.h */ -#ifndef OSAL_OVERRIDE_CTYPE_H -#define OSAL_OVERRIDE_CTYPE_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for ctype.h + */ + +#ifndef OVERRIDE_CTYPE_H +#define OVERRIDE_CTYPE_H #include "OCS_ctype.h" @@ -30,4 +36,4 @@ #define isgraph OCS_isgraph -#endif /* OSAL_OVERRIDE_CTYPE_H */ +#endif /* OVERRIDE_CTYPE_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/dirent.h b/src/unit-test-coverage/ut-stubs/override_inc/dirent.h index 4b3e706b0..34d15fb2c 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/dirent.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/dirent.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for dirent.h */ -#ifndef OSAL_OVERRIDE_DIRENT_H -#define OSAL_OVERRIDE_DIRENT_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for dirent.h + */ + +#ifndef OVERRIDE_DIRENT_H +#define OVERRIDE_DIRENT_H #include "OCS_dirent.h" @@ -35,4 +41,4 @@ #define readdir OCS_readdir #define rewinddir OCS_rewinddir -#endif /* OSAL_OVERRIDE_DIRENT_H */ +#endif /* OVERRIDE_DIRENT_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/dlfcn.h b/src/unit-test-coverage/ut-stubs/override_inc/dlfcn.h index ffa3ca272..9841944c0 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/dlfcn.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/dlfcn.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for dlfcn.h */ -#ifndef OSAL_OVERRIDE_DLFCN_H -#define OSAL_OVERRIDE_DLFCN_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for dlfcn.h + */ + +#ifndef OVERRIDE_DLFCN_H +#define OVERRIDE_DLFCN_H #include "OCS_dlfcn.h" @@ -33,4 +39,4 @@ #define dlopen OCS_dlopen #define dlsym OCS_dlsym -#endif /* OSAL_OVERRIDE_DLFCN_H */ +#endif /* OVERRIDE_DLFCN_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/dosFsLib.h b/src/unit-test-coverage/ut-stubs/override_inc/dosFsLib.h index e43ab7127..8d614cff0 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/dosFsLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/dosFsLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for dosFsLib.h */ -#ifndef OSAL_OVERRIDE_DOSFSLIB_H -#define OSAL_OVERRIDE_DOSFSLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for dosFsLib.h + */ + +#ifndef OVERRIDE_DOSFSLIB_H +#define OVERRIDE_DOSFSLIB_H #include "OCS_dosFsLib.h" #include @@ -36,4 +42,4 @@ #define dosFsVolFormat OCS_dosFsVolFormat -#endif /* OSAL_OVERRIDE_DOSFSLIB_H */ +#endif /* OVERRIDE_DOSFSLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/drv/hdisk/ataDrv.h b/src/unit-test-coverage/ut-stubs/override_inc/drv/hdisk/ataDrv.h index 9e7370008..ffe21300b 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/drv/hdisk/ataDrv.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/drv/hdisk/ataDrv.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for drv/hdisk/ataDrv.h */ -#ifndef OSAL_OVERRIDE_DRV_HDISK_ATADRV_H -#define OSAL_OVERRIDE_DRV_HDISK_ATADRV_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for drv/hdisk/ataDrv.h + */ + +#ifndef OVERRIDE_DRV_HDISK_ATADRV_H +#define OVERRIDE_DRV_HDISK_ATADRV_H #include "OCS_drv_hdisk_ataDrv.h" #include @@ -31,4 +37,4 @@ /* ----------------------------------------- */ #define ataDevCreate OCS_ataDevCreate -#endif /* OSAL_OVERRIDE_DRV_HDISK_ATADRV_H */ +#endif /* OVERRIDE_DRV_HDISK_ATADRV_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/errno.h b/src/unit-test-coverage/ut-stubs/override_inc/errno.h index 38735c41a..107415f5e 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/errno.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/errno.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for errno.h */ -#ifndef OSAL_OVERRIDE_ERRNO_H -#define OSAL_OVERRIDE_ERRNO_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for errno.h + */ + +#ifndef OVERRIDE_ERRNO_H +#define OVERRIDE_ERRNO_H #include "OCS_errno.h" @@ -40,4 +46,4 @@ #define errno OCS_errno -#endif /* OSAL_OVERRIDE_ERRNO_H */ +#endif /* OVERRIDE_ERRNO_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/errnoLib.h b/src/unit-test-coverage/ut-stubs/override_inc/errnoLib.h index d1965b2b6..ccb79a0cf 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/errnoLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/errnoLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for errnoLib.h */ -#ifndef OSAL_OVERRIDE_ERRNOLIB_H -#define OSAL_OVERRIDE_ERRNOLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for errnoLib.h + */ + +#ifndef OVERRIDE_ERRNOLIB_H +#define OVERRIDE_ERRNOLIB_H #include "OCS_errnoLib.h" #include @@ -30,4 +36,4 @@ /* ----------------------------------------- */ #define errnoGet OCS_errnoGet -#endif /* OSAL_OVERRIDE_ERRNOLIB_H */ +#endif /* OVERRIDE_ERRNOLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/fcntl.h b/src/unit-test-coverage/ut-stubs/override_inc/fcntl.h index dab3ef734..a133e7934 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/fcntl.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/fcntl.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for fcntl.h */ -#ifndef OSAL_OVERRIDE_FCNTL_H -#define OSAL_OVERRIDE_FCNTL_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for fcntl.h + */ + +#ifndef OVERRIDE_FCNTL_H +#define OVERRIDE_FCNTL_H #include "OCS_fcntl.h" @@ -56,4 +62,4 @@ #define fcntl OCS_fcntl #define open OCS_open -#endif /* OSAL_OVERRIDE_FCNTL_H */ +#endif /* OVERRIDE_FCNTL_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/fenv.h b/src/unit-test-coverage/ut-stubs/override_inc/fenv.h index 34a6e6531..159b59b36 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/fenv.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/fenv.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for fenv.h */ -#ifndef OSAL_OVERRIDE_FENV_H -#define OSAL_OVERRIDE_FENV_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for fenv.h + */ + +#ifndef OVERRIDE_FENV_H +#define OVERRIDE_FENV_H #include "OCS_fenv.h" @@ -28,4 +34,4 @@ /* mappings for declarations in fenv.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_FENV_H */ +#endif /* OVERRIDE_FENV_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/float.h b/src/unit-test-coverage/ut-stubs/override_inc/float.h index afdf0b572..4e4d10325 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/float.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/float.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for float.h */ -#ifndef OSAL_OVERRIDE_FLOAT_H -#define OSAL_OVERRIDE_FLOAT_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for float.h + */ + +#ifndef OVERRIDE_FLOAT_H +#define OVERRIDE_FLOAT_H #include "OCS_float.h" @@ -28,4 +34,4 @@ /* mappings for declarations in float.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_FLOAT_H */ +#endif /* OVERRIDE_FLOAT_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/hostLib.h b/src/unit-test-coverage/ut-stubs/override_inc/hostLib.h index add8ec46f..c7adc8034 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/hostLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/hostLib.h @@ -19,15 +19,14 @@ */ /** - * \file hostLib.h - * \ingroup ut-stubs - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup ut-stubs * * OSAL coverage stub replacement for hostLib.h */ -#ifndef HOSTLIB_H -#define HOSTLIB_H +#ifndef OVERRIDE_HOSTLIB_H +#define OVERRIDE_HOSTLIB_H #include "OCS_hostLib.h" #include @@ -37,4 +36,4 @@ /* ----------------------------------------- */ #define hostGetByName OCS_hostGetByName -#endif /* HOSTLIB_H */ +#endif /* OVERRIDE_HOSTLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/intLib.h b/src/unit-test-coverage/ut-stubs/override_inc/intLib.h index 736f08ad8..45d353ba0 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/intLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/intLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for intLib.h */ -#ifndef OSAL_OVERRIDE_INTLIB_H -#define OSAL_OVERRIDE_INTLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for intLib.h + */ + +#ifndef OVERRIDE_INTLIB_H +#define OVERRIDE_INTLIB_H #include "OCS_intLib.h" #include @@ -36,4 +42,4 @@ #define intUnlock OCS_intUnlock #define INUM_TO_IVEC OCS_INUM_TO_IVEC -#endif /* OSAL_OVERRIDE_INTLIB_H */ +#endif /* OVERRIDE_INTLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/inttypes.h b/src/unit-test-coverage/ut-stubs/override_inc/inttypes.h index 2b5633ee6..0e7871c48 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/inttypes.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/inttypes.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for inttypes.h */ -#ifndef OSAL_OVERRIDE_INTTYPES_H -#define OSAL_OVERRIDE_INTTYPES_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for inttypes.h + */ + +#ifndef OVERRIDE_INTTYPES_H +#define OVERRIDE_INTTYPES_H #include "OCS_inttypes.h" @@ -28,4 +34,4 @@ /* mappings for declarations in inttypes.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_INTTYPES_H */ +#endif /* OVERRIDE_INTTYPES_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/ioLib.h b/src/unit-test-coverage/ut-stubs/override_inc/ioLib.h index 1ced55120..a9ba0f0cc 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/ioLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/ioLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for ioLib.h */ -#ifndef OSAL_OVERRIDE_IOLIB_H -#define OSAL_OVERRIDE_IOLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for ioLib.h + */ + +#ifndef OVERRIDE_IOLIB_H +#define OVERRIDE_IOLIB_H #include "OCS_ioLib.h" #include @@ -33,4 +39,4 @@ #define FIOUNMOUNT OCS_FIOUNMOUNT #define ioctl OCS_ioctl -#endif /* OSAL_OVERRIDE_IOLIB_H */ +#endif /* OVERRIDE_IOLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/iv.h b/src/unit-test-coverage/ut-stubs/override_inc/iv.h index e0ec0fdab..8b7506d78 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/iv.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/iv.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for iv.h */ -#ifndef OSAL_OVERRIDE_IV_H -#define OSAL_OVERRIDE_IV_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for iv.h + */ + +#ifndef OVERRIDE_IV_H +#define OVERRIDE_IV_H #include "OCS_iv.h" @@ -28,4 +34,4 @@ /* mappings for declarations in iv.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_IV_H */ +#endif /* OVERRIDE_IV_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/loadLib.h b/src/unit-test-coverage/ut-stubs/override_inc/loadLib.h index 00e6a9f1d..7c4c9bef2 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/loadLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/loadLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for loadLib.h */ -#ifndef OSAL_OVERRIDE_LOADLIB_H -#define OSAL_OVERRIDE_LOADLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for loadLib.h + */ + +#ifndef OVERRIDE_LOADLIB_H +#define OVERRIDE_LOADLIB_H #include "OCS_loadLib.h" #include @@ -32,4 +38,4 @@ #define loadModule OCS_loadModule -#endif /* OSAL_OVERRIDE_LOADLIB_H */ +#endif /* OVERRIDE_LOADLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/locale.h b/src/unit-test-coverage/ut-stubs/override_inc/locale.h index da3c0920b..8095fb262 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/locale.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/locale.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for locale.h */ -#ifndef OSAL_OVERRIDE_LOCALE_H -#define OSAL_OVERRIDE_LOCALE_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for locale.h + */ + +#ifndef OVERRIDE_LOCALE_H +#define OVERRIDE_LOCALE_H #include "OCS_locale.h" @@ -28,4 +34,4 @@ /* mappings for declarations in locale.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_LOCALE_H */ +#endif /* OVERRIDE_LOCALE_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/logLib.h b/src/unit-test-coverage/ut-stubs/override_inc/logLib.h index 6be755fbb..9c6132faf 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/logLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/logLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for logLib.h */ -#ifndef OSAL_OVERRIDE_LOGLIB_H -#define OSAL_OVERRIDE_LOGLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for logLib.h + */ + +#ifndef OVERRIDE_LOGLIB_H +#define OVERRIDE_LOGLIB_H #include "OCS_logLib.h" #include @@ -29,4 +35,4 @@ /* mappings for declarations in logLib.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_LOGLIB_H */ +#endif /* OVERRIDE_LOGLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/math.h b/src/unit-test-coverage/ut-stubs/override_inc/math.h index 03a60c629..bf52d7fc9 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/math.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/math.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for math.h */ -#ifndef OSAL_OVERRIDE_MATH_H -#define OSAL_OVERRIDE_MATH_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for math.h + */ + +#ifndef OVERRIDE_MATH_H +#define OVERRIDE_MATH_H #include "OCS_math.h" @@ -28,4 +34,4 @@ /* mappings for declarations in math.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_MATH_H */ +#endif /* OVERRIDE_MATH_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/memPartLib.h b/src/unit-test-coverage/ut-stubs/override_inc/memPartLib.h index 5cde4f425..eb06a8afe 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/memPartLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/memPartLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for memPartLib.h */ -#ifndef OSAL_OVERRIDE_MEMPARTLIB_H -#define OSAL_OVERRIDE_MEMPARTLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for memPartLib.h + */ + +#ifndef OVERRIDE_MEMPARTLIB_H +#define OVERRIDE_MEMPARTLIB_H #include "OCS_memPartLib.h" #include @@ -35,4 +41,4 @@ #define memPartInfoGet OCS_memPartInfoGet #define memSysPartId OCS_memSysPartId -#endif /* OSAL_OVERRIDE_MEMPARTLIB_H */ +#endif /* OVERRIDE_MEMPARTLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/moduleLib.h b/src/unit-test-coverage/ut-stubs/override_inc/moduleLib.h index 5e8957d7e..9995fa763 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/moduleLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/moduleLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for moduleLib.h */ -#ifndef OSAL_OVERRIDE_MODULELIB_H -#define OSAL_OVERRIDE_MODULELIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for moduleLib.h + */ + +#ifndef OVERRIDE_MODULELIB_H +#define OVERRIDE_MODULELIB_H #include "OCS_moduleLib.h" #include @@ -34,4 +40,4 @@ #define moduleInfoGet OCS_moduleInfoGet -#endif /* OSAL_OVERRIDE_MODULELIB_H */ +#endif /* OVERRIDE_MODULELIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/mqueue.h b/src/unit-test-coverage/ut-stubs/override_inc/mqueue.h index 95f791d65..1fdcff31d 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/mqueue.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/mqueue.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for mqueue.h */ -#ifndef OSAL_OVERRIDE_MQUEUE_H -#define OSAL_OVERRIDE_MQUEUE_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for mqueue.h + */ + +#ifndef OVERRIDE_MQUEUE_H +#define OVERRIDE_MQUEUE_H #include "OCS_mqueue.h" #include @@ -39,4 +45,4 @@ #define mq_timedsend OCS_mq_timedsend #define mq_unlink OCS_mq_unlink -#endif /* OSAL_OVERRIDE_MQUEUE_H */ +#endif /* OVERRIDE_MQUEUE_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/msgQLib.h b/src/unit-test-coverage/ut-stubs/override_inc/msgQLib.h index 8bb978f79..35a012a26 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/msgQLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/msgQLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for msgQLib.h */ -#ifndef OSAL_OVERRIDE_MSGQLIB_H -#define OSAL_OVERRIDE_MSGQLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for msgQLib.h + */ + +#ifndef OVERRIDE_MSGQLIB_H +#define OVERRIDE_MSGQLIB_H #include "OCS_msgQLib.h" #include @@ -42,4 +48,4 @@ #define msgQReceive OCS_msgQReceive #define msgQSend OCS_msgQSend -#endif /* OSAL_OVERRIDE_MSGQLIB_H */ +#endif /* OVERRIDE_MSGQLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/net/if.h b/src/unit-test-coverage/ut-stubs/override_inc/net/if.h index b530ce1d4..6c9828cf8 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/net/if.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/net/if.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for net/if.h */ -#ifndef OSAL_OVERRIDE_NET_IF_H -#define OSAL_OVERRIDE_NET_IF_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for net/if.h + */ + +#ifndef OVERRIDE_NET_IF_H +#define OVERRIDE_NET_IF_H #include "OCS_net_if.h" @@ -28,4 +34,4 @@ /* mappings for declarations in net/if.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_NET_IF_H */ +#endif /* OVERRIDE_NET_IF_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/netdb.h b/src/unit-test-coverage/ut-stubs/override_inc/netdb.h index 693b08916..cce2fdd36 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/netdb.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/netdb.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for netdb.h */ -#ifndef OSAL_OVERRIDE_NETDB_H -#define OSAL_OVERRIDE_NETDB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for netdb.h + */ + +#ifndef OVERRIDE_NETDB_H +#define OVERRIDE_NETDB_H #include "OCS_netdb.h" @@ -28,4 +34,4 @@ /* mappings for declarations in netdb.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_NETDB_H */ +#endif /* OVERRIDE_NETDB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/netinet/in.h b/src/unit-test-coverage/ut-stubs/override_inc/netinet/in.h index 574d5a634..d451bcf38 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/netinet/in.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/netinet/in.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for netinet/in.h */ -#ifndef OSAL_OVERRIDE_NETINET_IN_H -#define OSAL_OVERRIDE_NETINET_IN_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for netinet/in.h + */ + +#ifndef OVERRIDE_NETINET_IN_H +#define OVERRIDE_NETINET_IN_H #include "OCS_netinet_in.h" @@ -33,4 +39,4 @@ #define htonl OCS_htonl #define ntohl OCS_ntohl -#endif /* OSAL_OVERRIDE_NETINET_IN_H */ +#endif /* OVERRIDE_NETINET_IN_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/netinet/tcp.h b/src/unit-test-coverage/ut-stubs/override_inc/netinet/tcp.h index f2f3fd8f3..c10a79f3b 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/netinet/tcp.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/netinet/tcp.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for netinet/tcp.h */ -#ifndef OSAL_OVERRIDE_NETINET_TCP_H -#define OSAL_OVERRIDE_NETINET_TCP_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for netinet/tcp.h + */ + +#ifndef OVERRIDE_NETINET_TCP_H +#define OVERRIDE_NETINET_TCP_H #include "OCS_netinet_tcp.h" @@ -28,4 +34,4 @@ /* mappings for declarations in netinet/tcp.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_NETINET_TCP_H */ +#endif /* OVERRIDE_NETINET_TCP_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/objLib.h b/src/unit-test-coverage/ut-stubs/override_inc/objLib.h index 1dc632151..b4bdc329a 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/objLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/objLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for objLib.h */ -#ifndef OSAL_OVERRIDE_OBJLIB_H -#define OSAL_OVERRIDE_OBJLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for objLib.h + */ + +#ifndef OVERRIDE_OBJLIB_H +#define OVERRIDE_OBJLIB_H #include "OCS_objLib.h" #include @@ -36,4 +42,4 @@ #define S_objLib_OBJ_TIMEOUT OCS_S_objLib_OBJ_TIMEOUT #define S_objLib_OBJ_NO_METHOD OCS_S_objLib_OBJ_NO_METHOD -#endif /* OSAL_OVERRIDE_OBJLIB_H */ +#endif /* OVERRIDE_OBJLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/poll.h b/src/unit-test-coverage/ut-stubs/override_inc/poll.h index bd879b5e3..0b942ed8e 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/poll.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/poll.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for poll.h */ -#ifndef OSAL_OVERRIDE_POLL_H -#define OSAL_OVERRIDE_POLL_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for poll.h + */ + +#ifndef OVERRIDE_POLL_H +#define OVERRIDE_POLL_H #include "OCS_poll.h" @@ -28,4 +34,4 @@ /* mappings for declarations in poll.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_POLL_H */ +#endif /* OVERRIDE_POLL_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/pthread.h b/src/unit-test-coverage/ut-stubs/override_inc/pthread.h index a4b5251d0..09192128a 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/pthread.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/pthread.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for pthread.h */ -#ifndef OSAL_OVERRIDE_PTHREAD_H -#define OSAL_OVERRIDE_PTHREAD_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for pthread.h + */ + +#ifndef OVERRIDE_PTHREAD_H +#define OVERRIDE_PTHREAD_H #include "OCS_pthread.h" #include @@ -76,4 +82,4 @@ #define pthread_setspecific OCS_pthread_setspecific #define pthread_sigmask OCS_pthread_sigmask -#endif /* OSAL_OVERRIDE_PTHREAD_H */ +#endif /* OVERRIDE_PTHREAD_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/ramDiskCbio.h b/src/unit-test-coverage/ut-stubs/override_inc/ramDiskCbio.h index 723259488..d52879649 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/ramDiskCbio.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/ramDiskCbio.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for ramDiskCbio.h */ -#ifndef OSAL_OVERRIDE_RAMDISKCBIO_H -#define OSAL_OVERRIDE_RAMDISKCBIO_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for ramDiskCbio.h + */ + +#ifndef OVERRIDE_RAMDISKCBIO_H +#define OVERRIDE_RAMDISKCBIO_H #include "OCS_ramDiskCbio.h" #include @@ -29,4 +35,4 @@ /* mappings for declarations in ramDiskCbio.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_RAMDISKCBIO_H */ +#endif /* OVERRIDE_RAMDISKCBIO_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/ramDrv.h b/src/unit-test-coverage/ut-stubs/override_inc/ramDrv.h index e0f68a4fe..20bbce99e 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/ramDrv.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/ramDrv.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for ramDrv.h */ -#ifndef OSAL_OVERRIDE_RAMDRV_H -#define OSAL_OVERRIDE_RAMDRV_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for ramDrv.h + */ + +#ifndef OVERRIDE_RAMDRV_H +#define OVERRIDE_RAMDRV_H #include "OCS_ramDrv.h" #include @@ -32,4 +38,4 @@ #define ramDevCreate OCS_ramDevCreate -#endif /* OSAL_OVERRIDE_RAMDRV_H */ +#endif /* OVERRIDE_RAMDRV_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sched.h b/src/unit-test-coverage/ut-stubs/override_inc/sched.h index 18c0d153b..b57f6663f 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sched.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sched.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sched.h */ -#ifndef OSAL_OVERRIDE_SCHED_H -#define OSAL_OVERRIDE_SCHED_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sched.h + */ + +#ifndef OVERRIDE_SCHED_H +#define OVERRIDE_SCHED_H #include "OCS_sched.h" @@ -36,4 +42,4 @@ #define sched_get_priority_max OCS_sched_get_priority_max #define sched_get_priority_min OCS_sched_get_priority_min -#endif /* OSAL_OVERRIDE_SCHED_H */ +#endif /* OVERRIDE_SCHED_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/selectLib.h b/src/unit-test-coverage/ut-stubs/override_inc/selectLib.h index d43a2a58b..710b970bc 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/selectLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/selectLib.h @@ -19,14 +19,14 @@ */ /** - * \file selectLib.h - * \ingroup ut-stubs - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup ut-stubs * + * Declarations and prototypes for selectLib */ -#ifndef SELECTLIB_H -#define SELECTLIB_H +#ifndef OVERRIDE_SELECTLIB_H +#define OVERRIDE_SELECTLIB_H #include #include @@ -35,4 +35,4 @@ /* mappings for declarations in selectLib.h */ /* ----------------------------------------- */ -#endif /* SELECTLIB_H */ +#endif /* OVERRIDE_SELECTLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/semLib.h b/src/unit-test-coverage/ut-stubs/override_inc/semLib.h index d40ab228f..0d7ac7c15 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/semLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/semLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for semLib.h */ -#ifndef OSAL_OVERRIDE_SEMLIB_H -#define OSAL_OVERRIDE_SEMLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for semLib.h + */ + +#ifndef OVERRIDE_SEMLIB_H +#define OVERRIDE_SEMLIB_H #include "OCS_semLib.h" #include @@ -54,4 +60,4 @@ #define semTake OCS_semTake #define semGive OCS_semGive -#endif /* OSAL_OVERRIDE_SEMLIB_H */ +#endif /* OVERRIDE_SEMLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/semaphore.h b/src/unit-test-coverage/ut-stubs/override_inc/semaphore.h index 6263e4943..3637e12a1 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/semaphore.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/semaphore.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for semaphore.h */ -#ifndef OSAL_OVERRIDE_SEMAPHORE_H -#define OSAL_OVERRIDE_SEMAPHORE_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for semaphore.h + */ + +#ifndef OVERRIDE_SEMAPHORE_H +#define OVERRIDE_SEMAPHORE_H #include "OCS_semaphore.h" #include @@ -36,4 +42,4 @@ #define sem_timedwait OCS_sem_timedwait #define sem_wait OCS_sem_wait -#endif /* OSAL_OVERRIDE_SEMAPHORE_H */ +#endif /* OVERRIDE_SEMAPHORE_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/setjmp.h b/src/unit-test-coverage/ut-stubs/override_inc/setjmp.h index ebe9e27cd..50a7b364a 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/setjmp.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/setjmp.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for setjmp.h */ -#ifndef OSAL_OVERRIDE_SETJMP_H -#define OSAL_OVERRIDE_SETJMP_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for setjmp.h + */ + +#ifndef OVERRIDE_SETJMP_H +#define OVERRIDE_SETJMP_H #include "OCS_setjmp.h" @@ -28,4 +34,4 @@ /* mappings for declarations in setjmp.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_SETJMP_H */ +#endif /* OVERRIDE_SETJMP_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/shellLib.h b/src/unit-test-coverage/ut-stubs/override_inc/shellLib.h index c175be692..2e60afd34 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/shellLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/shellLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for shellLib.h */ -#ifndef OSAL_OVERRIDE_SHELLLIB_H -#define OSAL_OVERRIDE_SHELLLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for shellLib.h + */ + +#ifndef OVERRIDE_SHELLLIB_H +#define OVERRIDE_SHELLLIB_H #include "OCS_shellLib.h" #include @@ -30,4 +36,4 @@ /* ----------------------------------------- */ #define shellGenericInit OCS_shellGenericInit -#endif /* OSAL_OVERRIDE_SHELLLIB_H */ +#endif /* OVERRIDE_SHELLLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/signal.h b/src/unit-test-coverage/ut-stubs/override_inc/signal.h index 1e63a85de..e24fc8a39 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/signal.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/signal.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for signal.h */ -#ifndef OSAL_OVERRIDE_SIGNAL_H -#define OSAL_OVERRIDE_SIGNAL_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for signal.h + */ + +#ifndef OVERRIDE_SIGNAL_H +#define OVERRIDE_SIGNAL_H #include "OCS_signal.h" @@ -56,4 +62,4 @@ #define sigsuspend OCS_sigsuspend #define sigwait OCS_sigwait -#endif /* OSAL_OVERRIDE_SIGNAL_H */ +#endif /* OVERRIDE_SIGNAL_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/stat.h b/src/unit-test-coverage/ut-stubs/override_inc/stat.h index e8760b467..d5229065d 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/stat.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/stat.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for stat.h */ -#ifndef OSAL_OVERRIDE_STAT_H -#define OSAL_OVERRIDE_STAT_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for stat.h + */ + +#ifndef OVERRIDE_STAT_H +#define OVERRIDE_STAT_H #include "OCS_stat.h" @@ -40,4 +46,4 @@ #define statvfs OCS_statvfs #define statfs OCS_statvfs -#endif /* OSAL_OVERRIDE_STAT_H */ +#endif /* OVERRIDE_STAT_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/stdarg.h b/src/unit-test-coverage/ut-stubs/override_inc/stdarg.h index 65e34c40e..7430ca4b3 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/stdarg.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/stdarg.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for stdarg.h */ -#ifndef OSAL_OVERRIDE_STDARG_H -#define OSAL_OVERRIDE_STDARG_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for stdarg.h + */ + +#ifndef OVERRIDE_STDARG_H +#define OVERRIDE_STDARG_H #include "OCS_stdarg.h" @@ -32,4 +38,4 @@ #define va_start(ap, last) OCS_va_start(ap, last) #define va_end(ap) OCS_va_end(ap) -#endif /* OSAL_OVERRIDE_STDARG_H */ +#endif /* OVERRIDE_STDARG_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/stdio.h b/src/unit-test-coverage/ut-stubs/override_inc/stdio.h index 2ca37d9dd..c069aeb2e 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/stdio.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/stdio.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for stdio.h */ -#ifndef OSAL_OVERRIDE_STDIO_H -#define OSAL_OVERRIDE_STDIO_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for stdio.h + */ + +#ifndef OVERRIDE_STDIO_H +#define OVERRIDE_STDIO_H #include "OCS_stdio.h" @@ -45,4 +51,4 @@ #define stdout OCS_stdout #define stderr OCS_stderr -#endif /* OSAL_OVERRIDE_STDIO_H */ +#endif /* OVERRIDE_STDIO_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/stdlib.h b/src/unit-test-coverage/ut-stubs/override_inc/stdlib.h index ca19025a4..0353bd0c8 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/stdlib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/stdlib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for stdlib.h */ -#ifndef OSAL_OVERRIDE_STDLIB_H -#define OSAL_OVERRIDE_STDLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for stdlib.h + */ + +#ifndef OVERRIDE_STDLIB_H +#define OVERRIDE_STDLIB_H #include "OCS_stdlib.h" @@ -37,4 +43,4 @@ #define malloc OCS_malloc #define free OCS_free -#endif /* OSAL_OVERRIDE_STDLIB_H */ +#endif /* OVERRIDE_STDLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/string.h b/src/unit-test-coverage/ut-stubs/override_inc/string.h index 82ef3a766..d2d59e92e 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/string.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/string.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for string.h */ -#ifndef OSAL_OVERRIDE_STRING_H -#define OSAL_OVERRIDE_STRING_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for string.h + */ + +#ifndef OVERRIDE_STRING_H +#define OVERRIDE_STRING_H #include "OCS_string.h" @@ -41,4 +47,4 @@ #define strncat OCS_strncat #define strerror OCS_strerror -#endif /* OSAL_OVERRIDE_STRING_H */ +#endif /* OVERRIDE_STRING_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/strings.h b/src/unit-test-coverage/ut-stubs/override_inc/strings.h index ed473d569..132e03098 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/strings.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/strings.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for strings.h */ -#ifndef OSAL_OVERRIDE_STRINGS_H -#define OSAL_OVERRIDE_STRINGS_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for strings.h + */ + +#ifndef OVERRIDE_STRINGS_H +#define OVERRIDE_STRINGS_H #include "OCS_strings.h" @@ -28,4 +34,4 @@ /* mappings for declarations in strings.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_STRINGS_H */ +#endif /* OVERRIDE_STRINGS_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/symLib.h b/src/unit-test-coverage/ut-stubs/override_inc/symLib.h index 340f5f1a5..ca43c780c 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/symLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/symLib.h @@ -19,14 +19,14 @@ */ /** - * \file symLib.h - * \ingroup ut-stubs - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup ut-stubs * + * Declarations and prototypes for symLib */ -#ifndef SYMLIB_H -#define SYMLIB_H +#ifndef OVERRIDE_SYMLIB_H +#define OVERRIDE_SYMLIB_H #include "OCS_symLib.h" #include @@ -51,4 +51,4 @@ #define symEach OCS_symEach #define symFind OCS_symFind -#endif /* SYMLIB_H */ +#endif /* OVERRIDE_SYMLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/ioctl.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/ioctl.h index 97daa628d..22d35e421 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/ioctl.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/ioctl.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/ioctl.h */ -#ifndef OSAL_OVERRIDE_SYS_IOCTL_H -#define OSAL_OVERRIDE_SYS_IOCTL_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/ioctl.h + */ + +#ifndef OVERRIDE_SYS_IOCTL_H +#define OVERRIDE_SYS_IOCTL_H #include "OCS_sys_ioctl.h" @@ -30,4 +36,4 @@ #define ioctl OCS_ioctl -#endif /* OSAL_OVERRIDE_SYS_IOCTL_H */ +#endif /* OVERRIDE_SYS_IOCTL_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/ipc.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/ipc.h index 7729af5f8..0f50ad0ce 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/ipc.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/ipc.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/ipc.h */ -#ifndef OSAL_OVERRIDE_SYS_IPC_H -#define OSAL_OVERRIDE_SYS_IPC_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/ipc.h + */ + +#ifndef OVERRIDE_SYS_IPC_H +#define OVERRIDE_SYS_IPC_H #include "OCS_sys_ipc.h" @@ -28,4 +34,4 @@ /* mappings for declarations in sys/ipc.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_SYS_IPC_H */ +#endif /* OVERRIDE_SYS_IPC_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/mman.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/mman.h index 9a64e0fc2..48d5435a8 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/mman.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/mman.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/mman.h */ -#ifndef OSAL_OVERRIDE_SYS_MMAN_H -#define OSAL_OVERRIDE_SYS_MMAN_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/mman.h + */ + +#ifndef OVERRIDE_SYS_MMAN_H +#define OVERRIDE_SYS_MMAN_H #include "OCS_sys_mman.h" @@ -38,4 +44,4 @@ #define mmap OCS_mmap #define munmap OCS_munmap -#endif /* OSAL_OVERRIDE_SYS_MMAN_H */ +#endif /* OVERRIDE_SYS_MMAN_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/select.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/select.h index 8db827c2b..09e79e7b2 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/select.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/select.h @@ -19,14 +19,14 @@ */ /** - * \file select.h - * \ingroup override_inc - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup ut-stubs * + * Declarations and prototypes for select */ -#ifndef SELECT_H -#define SELECT_H +#ifndef OVERRIDE_SYS_SELECT_H +#define OVERRIDE_SYS_SELECT_H #include "OCS_sys_select.h" @@ -52,4 +52,4 @@ #define FD_SETSIZE OCS_FD_SETSIZE -#endif /* SELECT_H */ +#endif /* OVERRIDE_SYS_SELECT_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/signal.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/signal.h index 0304c264e..1d7fea8c2 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/signal.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/signal.h @@ -18,11 +18,17 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/signal.h */ -#ifndef OSAL_OVERRIDE_SYS_SIGNAL_H -#define OSAL_OVERRIDE_SYS_SIGNAL_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/signal.h + */ + +#ifndef OVERRIDE_SYS_SIGNAL_H +#define OVERRIDE_SYS_SIGNAL_H /* alias to signal.h */ #include -#endif /* OSAL_OVERRIDE_SYS_SIGNAL_H */ +#endif /* OVERRIDE_SYS_SIGNAL_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/socket.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/socket.h index bec5af131..5d229e209 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/socket.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/socket.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/socket.h */ -#ifndef OSAL_OVERRIDE_SYS_SOCKET_H -#define OSAL_OVERRIDE_SYS_SOCKET_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/socket.h + */ + +#ifndef OVERRIDE_SYS_SOCKET_H +#define OVERRIDE_SYS_SOCKET_H #include "OCS_sys_socket.h" @@ -55,4 +61,4 @@ #define SO_ERROR OCS_SO_ERROR #define MSG_DONTWAIT OCS_MSG_DONTWAIT -#endif /* OSAL_OVERRIDE_SYS_SOCKET_H */ +#endif /* OVERRIDE_SYS_SOCKET_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/stat.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/stat.h index b6f5d80ce..455580de7 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/stat.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/stat.h @@ -18,11 +18,17 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/stat.h */ -#ifndef OSAL_OVERRIDE_SYS_STAT_H -#define OSAL_OVERRIDE_SYS_STAT_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/stat.h + */ + +#ifndef OVERRIDE_SYS_STAT_H +#define OVERRIDE_SYS_STAT_H /* alias to stat.h */ #include -#endif /* OSAL_OVERRIDE_SYS_STAT_H */ +#endif /* OVERRIDE_SYS_STAT_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/statvfs.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/statvfs.h index 7d53a30e2..574e2f1bb 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/statvfs.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/statvfs.h @@ -18,11 +18,17 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/statvfs.h */ -#ifndef OSAL_OVERRIDE_SYS_STATVFS_H -#define OSAL_OVERRIDE_SYS_STATVFS_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/statvfs.h + */ + +#ifndef OVERRIDE_SYS_STATVFS_H +#define OVERRIDE_SYS_STATVFS_H /* alias to stat.h */ #include -#endif /* OSAL_OVERRIDE_SYS_STATVFS_H */ +#endif /* OVERRIDE_SYS_STATVFS_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/time.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/time.h index ced41f62b..32cb8d356 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/time.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/time.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/time.h */ -#ifndef OSAL_OVERRIDE_SYS_TIME_H -#define OSAL_OVERRIDE_SYS_TIME_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/time.h + */ + +#ifndef OVERRIDE_SYS_TIME_H +#define OVERRIDE_SYS_TIME_H #include "OCS_sys_time.h" #include @@ -29,4 +35,4 @@ /* mappings for declarations in sys/time.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_SYS_TIME_H */ +#endif /* OVERRIDE_SYS_TIME_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/times.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/times.h index 810e64ce9..1311e334e 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/times.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/times.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/times.h */ -#ifndef OSAL_OVERRIDE_SYS_TIMES_H -#define OSAL_OVERRIDE_SYS_TIMES_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/times.h + */ + +#ifndef OVERRIDE_SYS_TIMES_H +#define OVERRIDE_SYS_TIMES_H #include "OCS_sys_times.h" #include @@ -29,4 +35,4 @@ /* mappings for declarations in sys/times.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_SYS_TIMES_H */ +#endif /* OVERRIDE_SYS_TIMES_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/types.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/types.h index 57dc1b06a..ba2258598 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/types.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/types.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/types.h */ -#ifndef OSAL_OVERRIDE_SYS_TYPES_H -#define OSAL_OVERRIDE_SYS_TYPES_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/types.h + */ + +#ifndef OVERRIDE_SYS_TYPES_H +#define OVERRIDE_SYS_TYPES_H #include "OCS_sys_types.h" @@ -35,4 +41,4 @@ #define uid_t OCS_uid_t #define u_short OCS_u_short -#endif /* OSAL_OVERRIDE_SYS_TYPES_H */ +#endif /* OVERRIDE_SYS_TYPES_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/un.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/un.h index fa11207fc..1fb648ea1 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/un.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/un.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/un.h */ -#ifndef OSAL_OVERRIDE_SYS_UN_H -#define OSAL_OVERRIDE_SYS_UN_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/un.h + */ + +#ifndef OVERRIDE_SYS_UN_H +#define OVERRIDE_SYS_UN_H #include "OCS_sys_un.h" @@ -28,4 +34,4 @@ /* mappings for declarations in sys/un.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_SYS_UN_H */ +#endif /* OVERRIDE_SYS_UN_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sys/wait.h b/src/unit-test-coverage/ut-stubs/override_inc/sys/wait.h index 056695e1d..b40b1520b 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sys/wait.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sys/wait.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sys/wait.h */ -#ifndef OSAL_OVERRIDE_SYS_WAIT_H -#define OSAL_OVERRIDE_SYS_WAIT_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sys/wait.h + */ + +#ifndef OVERRIDE_SYS_WAIT_H +#define OVERRIDE_SYS_WAIT_H #include "OCS_sys_wait.h" @@ -28,4 +34,4 @@ /* mappings for declarations in sys/wait.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_SYS_WAIT_H */ +#endif /* OVERRIDE_SYS_WAIT_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/sysLib.h b/src/unit-test-coverage/ut-stubs/override_inc/sysLib.h index a12d6f2aa..d10e055da 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/sysLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/sysLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for sysLib.h */ -#ifndef OSAL_OVERRIDE_SYSLIB_H -#define OSAL_OVERRIDE_SYSLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for sysLib.h + */ + +#ifndef OVERRIDE_SYSLIB_H +#define OVERRIDE_SYSLIB_H #include "OCS_sysLib.h" #include @@ -30,4 +36,4 @@ /* ----------------------------------------- */ #define sysClkRateGet OCS_sysClkRateGet -#endif /* OSAL_OVERRIDE_SYSLIB_H */ +#endif /* OVERRIDE_SYSLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/taskLib.h b/src/unit-test-coverage/ut-stubs/override_inc/taskLib.h index 8ad9d6a66..29cd06310 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/taskLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/taskLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for taskLib.h */ -#ifndef OSAL_OVERRIDE_TASKLIB_H -#define OSAL_OVERRIDE_TASKLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for taskLib.h + */ + +#ifndef OVERRIDE_TASKLIB_H +#define OVERRIDE_TASKLIB_H #include "OCS_taskLib.h" #include @@ -53,4 +59,4 @@ #define taskInit OCS_taskInit #define taskTcb OCS_taskTcb -#endif /* OSAL_OVERRIDE_TASKLIB_H */ +#endif /* OVERRIDE_TASKLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/taskVarLib.h b/src/unit-test-coverage/ut-stubs/override_inc/taskVarLib.h index c0b30e6b1..888b7bfd6 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/taskVarLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/taskVarLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for taskVarLib.h */ -#ifndef OSAL_OVERRIDE_TASKVARLIB_H -#define OSAL_OVERRIDE_TASKVARLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for taskVarLib.h + */ + +#ifndef OVERRIDE_TASKVARLIB_H +#define OVERRIDE_TASKVARLIB_H #include "OCS_taskVarLib.h" #include @@ -31,4 +37,4 @@ #define taskVarAdd OCS_taskVarAdd -#endif /* OSAL_OVERRIDE_TASKVARLIB_H */ +#endif /* OVERRIDE_TASKVARLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/termios.h b/src/unit-test-coverage/ut-stubs/override_inc/termios.h index e0778df4c..6bfeb3073 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/termios.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/termios.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for termios.h */ -#ifndef OSAL_OVERRIDE_TERMIOS_H -#define OSAL_OVERRIDE_TERMIOS_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for termios.h + */ + +#ifndef OVERRIDE_TERMIOS_H +#define OVERRIDE_TERMIOS_H #include "OCS_termios.h" @@ -28,4 +34,4 @@ /* mappings for declarations in termios.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_TERMIOS_H */ +#endif /* OVERRIDE_TERMIOS_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/tgmath.h b/src/unit-test-coverage/ut-stubs/override_inc/tgmath.h index a30170916..f54c7d784 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/tgmath.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/tgmath.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for tgmath.h */ -#ifndef OSAL_OVERRIDE_TGMATH_H -#define OSAL_OVERRIDE_TGMATH_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for tgmath.h + */ + +#ifndef OVERRIDE_TGMATH_H +#define OVERRIDE_TGMATH_H #include "OCS_tgmath.h" @@ -28,4 +34,4 @@ /* mappings for declarations in tgmath.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_TGMATH_H */ +#endif /* OVERRIDE_TGMATH_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/time.h b/src/unit-test-coverage/ut-stubs/override_inc/time.h index f0fdd91ba..e286a1ea0 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/time.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/time.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for time.h */ -#ifndef OSAL_OVERRIDE_TIME_H -#define OSAL_OVERRIDE_TIME_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for time.h + */ + +#ifndef OVERRIDE_TIME_H +#define OVERRIDE_TIME_H #include "OCS_time.h" @@ -51,4 +57,4 @@ #define timer_settime OCS_timer_settime #define timer_connect OCS_timer_connect -#endif /* OSAL_OVERRIDE_TIME_H */ +#endif /* OVERRIDE_TIME_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/timers.h b/src/unit-test-coverage/ut-stubs/override_inc/timers.h index d52461e71..3fefd7ae1 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/timers.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/timers.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for timers.h */ -#ifndef OSAL_OVERRIDE_TIMERS_H -#define OSAL_OVERRIDE_TIMERS_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for timers.h + */ + +#ifndef OVERRIDE_TIMERS_H +#define OVERRIDE_TIMERS_H #include "OCS_timers.h" #include @@ -29,4 +35,4 @@ * Note: this is just an alias for time.h */ -#endif /* OSAL_OVERRIDE_TIMERS_H */ +#endif /* OVERRIDE_TIMERS_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/ulimit.h b/src/unit-test-coverage/ut-stubs/override_inc/ulimit.h index d9029e798..6a3682746 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/ulimit.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/ulimit.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for ulimit.h */ -#ifndef OSAL_OVERRIDE_ULIMIT_H -#define OSAL_OVERRIDE_ULIMIT_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for ulimit.h + */ + +#ifndef OVERRIDE_ULIMIT_H +#define OVERRIDE_ULIMIT_H #include "OCS_ulimit.h" @@ -29,4 +35,4 @@ /* ----------------------------------------- */ #define ulimit OCS_ulimit -#endif /* OSAL_OVERRIDE_ULIMIT_H */ +#endif /* OVERRIDE_ULIMIT_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/unistd.h b/src/unit-test-coverage/ut-stubs/override_inc/unistd.h index becea6988..09d2b3601 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/unistd.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/unistd.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for unistd.h */ -#ifndef OSAL_OVERRIDE_UNISTD_H -#define OSAL_OVERRIDE_UNISTD_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for unistd.h + */ + +#ifndef OVERRIDE_UNISTD_H +#define OVERRIDE_UNISTD_H #include "OCS_unistd.h" @@ -47,4 +53,4 @@ #define sysconf OCS_sysconf #define write OCS_write -#endif /* OSAL_OVERRIDE_UNISTD_H */ +#endif /* OVERRIDE_UNISTD_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/unldLib.h b/src/unit-test-coverage/ut-stubs/override_inc/unldLib.h index b785a8784..b256768bd 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/unldLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/unldLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for unldLib.h */ -#ifndef OSAL_OVERRIDE_UNLDLIB_H -#define OSAL_OVERRIDE_UNLDLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for unldLib.h + */ + +#ifndef OVERRIDE_UNLDLIB_H +#define OVERRIDE_UNLDLIB_H #include "OCS_unldLib.h" #include @@ -31,4 +37,4 @@ /* ----------------------------------------- */ #define unldByModuleId OCS_unldByModuleId -#endif /* OSAL_OVERRIDE_UNLDLIB_H */ +#endif /* OVERRIDE_UNLDLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/usrLib.h b/src/unit-test-coverage/ut-stubs/override_inc/usrLib.h index 8139f7488..c3b1ad56c 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/usrLib.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/usrLib.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for usrLib.h */ -#ifndef OSAL_OVERRIDE_USRLIB_H -#define OSAL_OVERRIDE_USRLIB_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for usrLib.h + */ + +#ifndef OVERRIDE_USRLIB_H +#define OVERRIDE_USRLIB_H #include "OCS_usrLib.h" #include @@ -29,4 +35,4 @@ /* mappings for declarations in usrLib.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_USRLIB_H */ +#endif /* OVERRIDE_USRLIB_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/version.h b/src/unit-test-coverage/ut-stubs/override_inc/version.h index 95980c7ab..25cf491f6 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/version.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/version.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for version.h */ -#ifndef OSAL_OVERRIDE_VERSION_H -#define OSAL_OVERRIDE_VERSION_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for version.h + */ + +#ifndef OVERRIDE_VERSION_H +#define OVERRIDE_VERSION_H #include "OCS_version.h" @@ -28,4 +34,4 @@ /* mappings for declarations in version.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_VERSION_H */ +#endif /* OVERRIDE_VERSION_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/vxWorks.h b/src/unit-test-coverage/ut-stubs/override_inc/vxWorks.h index 93c28febd..6458fc4fc 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/vxWorks.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/vxWorks.h @@ -19,14 +19,14 @@ */ /** - * \file vxWorks.h - * \ingroup ut-stubs - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup ut-stubs * + * Declarations and prototypes for vxWorks */ -#ifndef VXWORKS_H -#define VXWORKS_H +#ifndef OVERRIDE_VXWORKS_H +#define OVERRIDE_VXWORKS_H #include "OCS_vxWorks.h" @@ -53,4 +53,4 @@ #define _Vx_usr_arg_t OCS_Vx_usr_arg_t -#endif /* VXWORKS_H */ +#endif /* OVERRIDE_VXWORKS_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/wchar.h b/src/unit-test-coverage/ut-stubs/override_inc/wchar.h index 6aaaaf783..fb3df8dbf 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/wchar.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/wchar.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for wchar.h */ -#ifndef OSAL_OVERRIDE_WCHAR_H -#define OSAL_OVERRIDE_WCHAR_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for wchar.h + */ + +#ifndef OVERRIDE_WCHAR_H +#define OVERRIDE_WCHAR_H #include "OCS_wchar.h" @@ -28,4 +34,4 @@ /* mappings for declarations in wchar.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_WCHAR_H */ +#endif /* OVERRIDE_WCHAR_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/wctype.h b/src/unit-test-coverage/ut-stubs/override_inc/wctype.h index b0458a749..8215dfee9 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/wctype.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/wctype.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for wctype.h */ -#ifndef OSAL_OVERRIDE_WCTYPE_H -#define OSAL_OVERRIDE_WCTYPE_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for wctype.h + */ + +#ifndef OVERRIDE_WCTYPE_H +#define OVERRIDE_WCTYPE_H #include "OCS_wctype.h" @@ -28,4 +34,4 @@ /* mappings for declarations in wctype.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_WCTYPE_H */ +#endif /* OVERRIDE_WCTYPE_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/xbdBlkDev.h b/src/unit-test-coverage/ut-stubs/override_inc/xbdBlkDev.h index 20bc0dfcb..b6d75f740 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/xbdBlkDev.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/xbdBlkDev.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for xbdBlkDev.h */ -#ifndef OSAL_OVERRIDE_XBDBLKDEV_H -#define OSAL_OVERRIDE_XBDBLKDEV_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for xbdBlkDev.h + */ + +#ifndef OVERRIDE_XBDBLKDEV_H +#define OVERRIDE_XBDBLKDEV_H #include "OCS_xbdBlkDev.h" #include @@ -35,4 +41,4 @@ #define xbdBlkDevCreateSync OCS_xbdBlkDevCreateSync #define xbdBlkDevDelete OCS_xbdBlkDevDelete -#endif /* OSAL_OVERRIDE_XBDBLKDEV_H */ +#endif /* OVERRIDE_XBDBLKDEV_H */ diff --git a/src/unit-test-coverage/ut-stubs/override_inc/xbdRamDisk.h b/src/unit-test-coverage/ut-stubs/override_inc/xbdRamDisk.h index 57f9db894..8d1f11082 100644 --- a/src/unit-test-coverage/ut-stubs/override_inc/xbdRamDisk.h +++ b/src/unit-test-coverage/ut-stubs/override_inc/xbdRamDisk.h @@ -18,9 +18,15 @@ * limitations under the License. */ -/* OSAL coverage stub replacement for xbdRamDisk.h */ -#ifndef OSAL_OVERRIDE_XBDRAMDISK_H -#define OSAL_OVERRIDE_XBDRAMDISK_H +/** + * \file + * \ingroup ut-stubs + * + * OSAL coverage stub replacement for xbdRamDisk.h + */ + +#ifndef OVERRIDE_XBDRAMDISK_H +#define OVERRIDE_XBDRAMDISK_H #include "OCS_xbdRamDisk.h" #include @@ -29,4 +35,4 @@ /* mappings for declarations in xbdRamDisk.h */ /* ----------------------------------------- */ -#endif /* OSAL_OVERRIDE_XBDRAMDISK_H */ +#endif /* OVERRIDE_XBDRAMDISK_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-binsem.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-binsem.h index e3ced2751..d2778dce9 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-binsem.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-binsem.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-binsem.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-binsem */ #ifndef UT_ADAPTOR_BINSEM_H @@ -48,4 +48,4 @@ extern const UT_EntryKey_t UT_StubKey_GenericSemGive; extern int32 UT_Call_OS_VxWorks_BinSemAPI_Impl_Init(void); -#endif /* UT_ADAPTOR_BINSEM_H */ +#endif /* UT_ADAPTOR_BINSEM_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-common.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-common.h index ece0fa66c..f6597a5cf 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-common.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-common.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-common.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-common */ #ifndef UT_ADAPTOR_COMMON_H @@ -55,4 +55,4 @@ extern int32 OS_VxWorks_GenericSemGive(OCS_SEM_ID vxid); */ extern const UT_EntryKey_t UT_StubKey_OS_VxWorks_TableMutex_Init; -#endif /* UT_ADAPTOR_COMMON_H */ +#endif /* UT_ADAPTOR_COMMON_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-console.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-console.h index 2d45fbafb..73890d11b 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-console.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-console.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-console.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-console */ #ifndef UT_ADAPTOR_CONSOLE_H @@ -44,4 +44,4 @@ extern void UT_ConsoleTest_TaskEntry(int arg); */ extern void UT_ConsoleTest_SetConsoleAsync(osal_index_t local_id, bool is_async); -#endif /* UT_ADAPTOR_CONSOLE_H */ +#endif /* UT_ADAPTOR_CONSOLE_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-countsem.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-countsem.h index 57eb05ac5..f42c55cb6 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-countsem.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-countsem.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-countsem.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-countsem */ #ifndef UT_ADAPTOR_COUNTSEM_H @@ -46,4 +46,4 @@ extern size_t const UT_Ref_OS_impl_count_sem_table_SIZE; int32 UT_Call_OS_VxWorks_CountSemAPI_Impl_Init(void); -#endif /* UT_ADAPTOR_COUNTSEM_H */ +#endif /* UT_ADAPTOR_COUNTSEM_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-dirs.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-dirs.h index d528b209e..87f92704a 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-dirs.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-dirs.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-dirs.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-dirs */ #ifndef UT_ADAPTOR_DIRS_H @@ -44,4 +44,4 @@ */ extern int32 UT_Call_OS_VxWorks_DirAPI_Impl_Init(void); -#endif /* UT_ADAPTOR_DIRS_H */ +#endif /* UT_ADAPTOR_DIRS_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-files.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-files.h index a77d79ce8..3de4aa2bd 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-files.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-files.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-files.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-files */ #ifndef UT_ADAPTOR_FILES_H @@ -55,4 +55,4 @@ unsigned int UT_FileTest_GetSelfEGID(void); void UT_FileTest_Set_Selectable(osal_index_t local_id, bool is_selectable); -#endif /* UT_ADAPTOR_FILES_H */ +#endif /* UT_ADAPTOR_FILES_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-filesys.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-filesys.h index 88242f384..3fdad1fa1 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-filesys.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-filesys.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-filesys.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-filesys */ #ifndef UT_ADAPTOR_FILESYS_H @@ -36,4 +36,4 @@ extern size_t const UT_Ref_OS_impl_filesys_table_SIZE; void UT_FileSysTest_SetupFileSysEntry(osal_index_t id, OCS_BLK_DEV *blkdev, OCS_device_t xbddev, uint32 MaxParts); -#endif /* UT_ADAPTOR_FILESYS_H */ +#endif /* UT_ADAPTOR_FILESYS_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-filetable-stub.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-filetable-stub.h index 06c1226ca..4205fdbe9 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-filetable-stub.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-filetable-stub.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-filetable-stub.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-filetable-stub */ #ifndef UT_ADAPTOR_FILETABLE_STUB_H @@ -34,4 +34,4 @@ extern void *const UT_FileTableTest_OS_impl_filehandle_table; extern size_t const UT_FileTableTest_OS_impl_filehandle_table_SIZE; -#endif /* UT_ADAPTOR_FILETABLE_STUB_H */ +#endif /* UT_ADAPTOR_FILETABLE_STUB_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-idmap.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-idmap.h index b3483c92d..0ccb753e4 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-idmap.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-idmap.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-idmap.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-idmap */ #ifndef UT_ADAPTOR_IDMAP_H @@ -42,4 +42,4 @@ int32 UT_Call_OS_VxWorks_TableMutex_Init(osal_objtype_t idtype); void UT_IdMapTest_SetImplTableMutex(osal_objtype_t idtype, OCS_SEM_ID vxid); -#endif /* UT_ADAPTOR_IDMAP_H */ +#endif /* UT_ADAPTOR_IDMAP_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-loader.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-loader.h index 71dbe1c1f..a26dda771 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-loader.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-loader.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-loader.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-loader */ #ifndef UT_ADAPTOR_LOADER_H @@ -38,4 +38,4 @@ extern size_t const UT_Ref_OS_impl_module_table_SIZE; extern int32 UT_Call_OS_VxWorks_ModuleAPI_Impl_Init(void); -#endif /* UT_ADAPTOR_LOADER_H */ +#endif /* UT_ADAPTOR_LOADER_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-mutex.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-mutex.h index d92366e3c..dbc1a23a6 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-mutex.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-mutex.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-mutex.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-mutex */ #ifndef UT_ADAPTOR_MUTEX_H @@ -46,4 +46,4 @@ extern size_t const UT_Ref_OS_impl_mutex_table_SIZE; int32 UT_Call_OS_VxWorks_MutexAPI_Impl_Init(void); -#endif /* UT_ADAPTOR_MUTEX_H */ +#endif /* UT_ADAPTOR_MUTEX_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-queues.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-queues.h index 6ea819a9b..0310627ed 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-queues.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-queues.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-queues.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-queues */ #ifndef UT_ADAPTOR_QUEUES_H @@ -45,4 +45,4 @@ extern size_t const UT_Ref_OS_impl_queue_table_SIZE; int32 UT_Call_OS_VxWorks_QueueAPI_Impl_Init(void); -#endif /* UT_ADAPTOR_QUEUES_H */ +#endif /* UT_ADAPTOR_QUEUES_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-symtab.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-symtab.h index 7a57eba32..0562445ce 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-symtab.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-symtab.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-symtab.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-symtab */ #ifndef UT_ADAPTOR_SYMTAB_H @@ -33,4 +33,4 @@ int32 UT_SymTabTest_CallIteratorFunc(const char *name, void *val, size_t TestSize, size_t SizeLimit); int32 UT_SymTabTest_GetIteratorStatus(void); -#endif /* UT_ADAPTOR_SYMTAB_H */ +#endif /* UT_ADAPTOR_SYMTAB_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-tasks.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-tasks.h index 6a147f521..92c8abab5 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-tasks.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-tasks.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-tasks.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-tasks */ #ifndef UT_ADAPTOR_TASKS_H @@ -48,4 +48,4 @@ void UT_TaskTest_SetImplTaskId(osal_index_t local_id, OCS_TASK_ID TaskI int UT_TaskTest_CallEntryPoint(osal_id_t arg); OCS_WIND_TCB *UT_TaskTest_GetTaskTcb(osal_index_t local_id); -#endif /* UT_ADAPTOR_TASKS_H */ +#endif /* UT_ADAPTOR_TASKS_H */ diff --git a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-timebase.h b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-timebase.h index 6317489c5..557bb9d73 100644 --- a/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-timebase.h +++ b/src/unit-test-coverage/vxworks/adaptors/inc/ut-adaptor-timebase.h @@ -19,10 +19,10 @@ */ /** - * \file ut-adaptor-timebase.h - * \ingroup adaptors - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup adaptors * + * Declarations and prototypes for ut-adaptor-timebase */ #ifndef UT_ADAPTOR_TIMEBASE_H @@ -62,4 +62,4 @@ bool UT_TimeBaseTest_CheckTimeBaseErrorState(osal_index_t local_id); /* Invoke the internal UsecToTimespec API */ void UT_TimeBaseTest_UsecToTimespec(uint32 usecs, struct OCS_timespec *time_spec); -#endif /* UT_ADAPTOR_TIMEBASE_H */ +#endif /* UT_ADAPTOR_TIMEBASE_H */ diff --git a/src/unit-test-coverage/vxworks/src/os-vxworks-coveragetest.h b/src/unit-test-coverage/vxworks/src/os-vxworks-coveragetest.h index aeada46d6..c9e5b1753 100644 --- a/src/unit-test-coverage/vxworks/src/os-vxworks-coveragetest.h +++ b/src/unit-test-coverage/vxworks/src/os-vxworks-coveragetest.h @@ -19,10 +19,10 @@ */ /** - * \file os-vxworks-coveragetest.h - * \ingroup vxworks - * \author joseph.p.hickey@nasa.gov + * \file + * \ingroup vxworks * + * Declarations and prototypes for os-vxworks-coveragetest */ #ifndef OS_VXWORKS_COVERAGETEST_H @@ -71,4 +71,4 @@ void Osapi_Test_Setup(void); void Osapi_Test_Teardown(void); -#endif /* OS_VXWORKS_COVERAGETEST_H */ +#endif /* OS_VXWORKS_COVERAGETEST_H */ diff --git a/src/unit-tests/inc/ut_os_support.h b/src/unit-tests/inc/ut_os_support.h index ff7c9144e..e285a1e74 100644 --- a/src/unit-tests/inc/ut_os_support.h +++ b/src/unit-tests/inc/ut_os_support.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_os_support.h -** Owner: Tam Ngo -** Date: May 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: May 2013 + */ #ifndef UT_OS_SUPPORT_H #define UT_OS_SUPPORT_H @@ -136,7 +137,3 @@ static inline bool UtOsalImplemented(int32 Fn, const char *File, uint32 Line) /*--------------------------------------------------------------------------------*/ #endif /* UT_OS_SUPPORT_H */ - -/*================================================================================* -** End of File: ut_os_support.h -**================================================================================*/ diff --git a/src/unit-tests/oscore-test/ut_oscore_binsem_test.h b/src/unit-tests/oscore-test/ut_oscore_binsem_test.h index 081a87d3a..9f006105c 100644 --- a/src/unit-tests/oscore-test/ut_oscore_binsem_test.h +++ b/src/unit-tests/oscore-test/ut_oscore_binsem_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_oscore_binsem_test.h -** Owner: Alan Cudmore -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Alan Cudmore + * Date: April 2013 + */ #ifndef UT_OSCORE_BINSEM_TEST_H #define UT_OSCORE_BINSEM_TEST_H @@ -65,7 +66,3 @@ void UT_os_bin_sem_get_info_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSCORE_BINSEM_TEST_H */ - -/*================================================================================* -** End of File: ut_oscore_binsem_test.h -**================================================================================*/ diff --git a/src/unit-tests/oscore-test/ut_oscore_countsem_test.h b/src/unit-tests/oscore-test/ut_oscore_countsem_test.h index 6cad49f9c..c5a6aba06 100644 --- a/src/unit-tests/oscore-test/ut_oscore_countsem_test.h +++ b/src/unit-tests/oscore-test/ut_oscore_countsem_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_oscore_countsem_test.h -** Owner: Alan Cudmore -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Alan Cudmore + * Date: April 2013 + */ #ifndef UT_OSCORE_COUNTSEM_TEST_H #define UT_OSCORE_COUNTSEM_TEST_H @@ -64,7 +65,3 @@ void UT_os_count_sem_get_info_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSCORE_COUNTSEM_TEST_H */ - -/*================================================================================* -** End of File: ut_oscore_countsem_test.h -**================================================================================*/ diff --git a/src/unit-tests/oscore-test/ut_oscore_misc_test.h b/src/unit-tests/oscore-test/ut_oscore_misc_test.h index 4cf6fb5c5..02864f319 100644 --- a/src/unit-tests/oscore-test/ut_oscore_misc_test.h +++ b/src/unit-tests/oscore-test/ut_oscore_misc_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_oscore_misc_test.h -** Owner: Tam Ngo -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: April 2013 + */ #ifndef UT_OSCORE_MISC_TEST_H #define UT_OSCORE_MISC_TEST_H @@ -69,7 +70,3 @@ void UT_os_heapgetinfo_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSCORE_MISC_TEST_H */ - -/*================================================================================* -** End of File: ut_oscore_misc_test.h -**================================================================================*/ diff --git a/src/unit-tests/oscore-test/ut_oscore_mutex_test.h b/src/unit-tests/oscore-test/ut_oscore_mutex_test.h index 50fdec19b..3e1aaed3d 100644 --- a/src/unit-tests/oscore-test/ut_oscore_mutex_test.h +++ b/src/unit-tests/oscore-test/ut_oscore_mutex_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_oscore_mutex_test.h -** Owner: Alan Cudmore -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Alan Cudmore + * Date: April 2013 + */ #ifndef UT_OSCORE_MUTEX_TEST_H #define UT_OSCORE_MUTEX_TEST_H @@ -63,7 +64,3 @@ void UT_os_mut_sem_get_info_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSCORE_MUTEX_TEST_H */ - -/*================================================================================* -** End of File: ut_oscore_mutex_test.h -**================================================================================*/ diff --git a/src/unit-tests/oscore-test/ut_oscore_queue_test.h b/src/unit-tests/oscore-test/ut_oscore_queue_test.h index 1a45d3e2e..88f2516ea 100644 --- a/src/unit-tests/oscore-test/ut_oscore_queue_test.h +++ b/src/unit-tests/oscore-test/ut_oscore_queue_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_oscore_queue_test.h -** Owner: Alan Cudmore -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Alan Cudmore + * Date: April 2013 + */ #ifndef UT_OSCORE_QUEUE_TEST_H #define UT_OSCORE_QUEUE_TEST_H @@ -63,7 +64,3 @@ void UT_os_queue_get_info_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSCORE_QUEUE_TEST_H */ - -/*================================================================================* -** End of File: ut_oscore_queue_test.h -**================================================================================*/ diff --git a/src/unit-tests/oscore-test/ut_oscore_select_test.h b/src/unit-tests/oscore-test/ut_oscore_select_test.h index 467e5707a..6f6c10258 100644 --- a/src/unit-tests/oscore-test/ut_oscore_select_test.h +++ b/src/unit-tests/oscore-test/ut_oscore_select_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_oscore_select_test.h -** Owner: Chris Knight -** Date: March 2020 -**================================================================================*/ +/** + * \file + * + * Owner: Chris Knight + * Date: March 2020 + */ #ifndef UT_OSCORE_SELECT_TEST_H #define UT_OSCORE_SELECT_TEST_H @@ -60,7 +61,3 @@ void UT_os_select_multi_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSCORE_SELECT_TEST_H */ - -/*================================================================================* -** End of File: ut_oscore_select_test.h -**================================================================================*/ diff --git a/src/unit-tests/oscore-test/ut_oscore_task_test.h b/src/unit-tests/oscore-test/ut_oscore_task_test.h index 60b35ad5b..9ff125d66 100644 --- a/src/unit-tests/oscore-test/ut_oscore_task_test.h +++ b/src/unit-tests/oscore-test/ut_oscore_task_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_oscore_task_test.h -** Owner: Alan Cudmore -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Alan Cudmore + * Date: April 2013 + */ #ifndef UT_OSCORE_TASK_TEST_H #define UT_OSCORE_TASK_TEST_H @@ -70,7 +71,3 @@ void UT_os_task_get_id_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSCORE_TASK_TEST_H */ - -/*================================================================================* -** End of File: ut_oscore_task_test.h -**================================================================================*/ diff --git a/src/unit-tests/oscore-test/ut_oscore_test.h b/src/unit-tests/oscore-test/ut_oscore_test.h index 2c412a6a0..1d28a5157 100644 --- a/src/unit-tests/oscore-test/ut_oscore_test.h +++ b/src/unit-tests/oscore-test/ut_oscore_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_oscore_test.h -** Owner: Tam Ngo/Alan Cudmore -** Date: May 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo/Alan Cudmore + * Date: May 2013 + */ #ifndef UT_OSCORE_TEST_H #define UT_OSCORE_TEST_H @@ -63,7 +64,3 @@ /*--------------------------------------------------------------------------------*/ #endif /* UT_OSCORE_TEST_H */ - -/*================================================================================* -** End of File: ut_oscore_test_posix.h -**================================================================================*/ diff --git a/src/unit-tests/osfile-test/ut_osfile_dirio_test.h b/src/unit-tests/osfile-test/ut_osfile_dirio_test.h index 04ff11525..af2af13e4 100644 --- a/src/unit-tests/osfile-test/ut_osfile_dirio_test.h +++ b/src/unit-tests/osfile-test/ut_osfile_dirio_test.h @@ -18,14 +18,15 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_osfile_dirio.h -** Owner: Tam Ngo -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: April 2013 + */ -#ifndef UT_OSFILE_DIRIO_H -#define UT_OSFILE_DIRIO_H +#ifndef UT_OSFILE_DIRIO_TEST_H +#define UT_OSFILE_DIRIO_TEST_H /*--------------------------------------------------------------------------------* ** Includes @@ -64,8 +65,4 @@ void UT_os_removedir_test(void); /*--------------------------------------------------------------------------------*/ -#endif /* UT_OSFILE_DIRIO_H */ - -/*================================================================================* -** End of File: ut_osfile_dirio.h -**================================================================================*/ +#endif /* UT_OSFILE_DIRIO_TEST_H */ diff --git a/src/unit-tests/osfile-test/ut_osfile_fileio_test.h b/src/unit-tests/osfile-test/ut_osfile_fileio_test.h index 6f149a3ca..69f0296d6 100644 --- a/src/unit-tests/osfile-test/ut_osfile_fileio_test.h +++ b/src/unit-tests/osfile-test/ut_osfile_fileio_test.h @@ -18,14 +18,15 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_osfile_fileio.h -** Owner: Tam Ngo -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: April 2013 + */ -#ifndef UT_OSFILE_FILEIO_H -#define UT_OSFILE_FILEIO_H +#ifndef UT_OSFILE_FILEIO_TEST_H +#define UT_OSFILE_FILEIO_TEST_H /*--------------------------------------------------------------------------------* ** Includes @@ -80,8 +81,4 @@ void UT_os_closefilebyname_test(void); /*--------------------------------------------------------------------------------*/ -#endif /* UT_OSFILE_FILEIO_H */ - -/*================================================================================* -** End of File: ut_osfile_fileio.h -**================================================================================*/ +#endif /* UT_OSFILE_FILEIO_TEST_H */ diff --git a/src/unit-tests/osfile-test/ut_osfile_test.h b/src/unit-tests/osfile-test/ut_osfile_test.h index 53459e6e4..1e74d8592 100644 --- a/src/unit-tests/osfile-test/ut_osfile_test.h +++ b/src/unit-tests/osfile-test/ut_osfile_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_osfile_test.h -** Owner: Tam Ngo -** Date: May 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: May 2013 + */ #ifndef UT_OSFILE_TEST_H #define UT_OSFILE_TEST_H @@ -58,7 +59,3 @@ /*--------------------------------------------------------------------------------*/ #endif /* UT_OSFILE_TEST_H */ - -/*================================================================================* -** End of File: ut_osfile_test.h -**================================================================================*/ diff --git a/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.h b/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.h index b2573eb66..d4f9dae87 100644 --- a/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.h +++ b/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_osfilesys_diskio_test.h -** Owner: Tam Ngo -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: April 2013 + */ #ifndef UT_OSFILESYS_DISKIO_TEST_H #define UT_OSFILESYS_DISKIO_TEST_H @@ -74,7 +75,3 @@ void UT_os_fsstatvolume_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSFILESYS_DISKIO_TEST_H */ - -/*================================================================================* -** End of File: ut_osfilesys_diskio_test.h -**================================================================================*/ diff --git a/src/unit-tests/osfilesys-test/ut_osfilesys_test.h b/src/unit-tests/osfilesys-test/ut_osfilesys_test.h index 7e78dbd91..3ecbd3913 100644 --- a/src/unit-tests/osfilesys-test/ut_osfilesys_test.h +++ b/src/unit-tests/osfilesys-test/ut_osfilesys_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_osfilesys_test.h -** Owner: Tam Ngo -** Date: May 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: May 2013 + */ #ifndef UT_OSFILESYS_TEST_H #define UT_OSFILESYS_TEST_H @@ -57,7 +58,3 @@ /*--------------------------------------------------------------------------------*/ #endif /* UT_OSFILESYS_TEST_H */ - -/*================================================================================* -** End of File: ut_osfilesys_test.h -**================================================================================*/ diff --git a/src/unit-tests/osloader-test/ut_osloader_module_test.h b/src/unit-tests/osloader-test/ut_osloader_module_test.h index 70057ea10..d79005f22 100644 --- a/src/unit-tests/osloader-test/ut_osloader_module_test.h +++ b/src/unit-tests/osloader-test/ut_osloader_module_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_osloader_module_test.h -** Owner: Tam Ngo -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: April 2013 + */ #ifndef UT_OSLOADER_MODULE_TEST_H #define UT_OSLOADER_MODULE_TEST_H @@ -60,7 +61,3 @@ void UT_os_module_info_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSLOADER_MODULE_TEST_H */ - -/*================================================================================* -** End of File: ut_osloader_module_test.h -**================================================================================*/ diff --git a/src/unit-tests/osloader-test/ut_osloader_symtable_test.h b/src/unit-tests/osloader-test/ut_osloader_symtable_test.h index 5e572362a..01054d86a 100644 --- a/src/unit-tests/osloader-test/ut_osloader_symtable_test.h +++ b/src/unit-tests/osloader-test/ut_osloader_symtable_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_osloader_symtable_test.h -** Owner: Tam Ngo -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: April 2013 + */ #ifndef UT_OSLOADER_SYMTABLE_TEST_H #define UT_OSLOADER_SYMTABLE_TEST_H @@ -60,7 +61,3 @@ void UT_os_symbol_table_dump_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSLOADER_SYMTABLE_TEST_H */ - -/*================================================================================* -** End of File: ut_osloader_symtable_test.h -**================================================================================*/ diff --git a/src/unit-tests/osloader-test/ut_osloader_test.h b/src/unit-tests/osloader-test/ut_osloader_test.h index 61c0175d6..714fd840e 100644 --- a/src/unit-tests/osloader-test/ut_osloader_test.h +++ b/src/unit-tests/osloader-test/ut_osloader_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_osloader_test.h -** Owner: Tam Ngo -** Date: May 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: May 2013 + */ #ifndef UT_OSLOADER_TEST_H #define UT_OSLOADER_TEST_H @@ -58,7 +59,3 @@ /*--------------------------------------------------------------------------------*/ #endif /* UT_OSLOADER_TEST_H */ - -/*================================================================================* -** End of File: ut_osloader_test.h -**================================================================================*/ diff --git a/src/unit-tests/osloader-test/ut_osloader_test_platforms.h b/src/unit-tests/osloader-test/ut_osloader_test_platforms.h index 0e62c9206..c4ae4b7ed 100644 --- a/src/unit-tests/osloader-test/ut_osloader_test_platforms.h +++ b/src/unit-tests/osloader-test/ut_osloader_test_platforms.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_osloader_test_platforms.h -** Owner: Tam Ngo -** Date: November 2014 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: November 2014 + */ #ifndef UT_OSLOADER_TEST_PLATFORMS_H #define UT_OSLOADER_TEST_PLATFORMS_H @@ -64,7 +65,3 @@ /*--------------------------------------------------------------------------------*/ #endif /* UT_OSLOADER_TEST_PLATFORMS_H */ - -/*================================================================================* -** End of File: ut_osloader_test_platforms.h -**================================================================================*/ diff --git a/src/unit-tests/osnetwork-test/ut_osnetwork_misc_test.h b/src/unit-tests/osnetwork-test/ut_osnetwork_misc_test.h index 038aff40f..42620fc96 100644 --- a/src/unit-tests/osnetwork-test/ut_osnetwork_misc_test.h +++ b/src/unit-tests/osnetwork-test/ut_osnetwork_misc_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_osnetwork_misc_test.h -** Owner: Tam Ngo -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: April 2013 + */ #ifndef UT_OSNETWORK_MISC_TEST_H #define UT_OSNETWORK_MISC_TEST_H @@ -59,7 +60,3 @@ void UT_os_networkgethostname_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSNETWORK_MISC_TEST_H */ - -/*================================================================================* -** End of File: ut_osnetwork_misc_test.h -**================================================================================*/ diff --git a/src/unit-tests/osnetwork-test/ut_osnetwork_test.h b/src/unit-tests/osnetwork-test/ut_osnetwork_test.h index 90a29fc72..cd36fae11 100644 --- a/src/unit-tests/osnetwork-test/ut_osnetwork_test.h +++ b/src/unit-tests/osnetwork-test/ut_osnetwork_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_osnetwork_test.h -** Owner: Tam Ngo -** Date: May 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: May 2013 + */ #ifndef UT_OSNETWORK_TEST_H #define UT_OSNETWORK_TEST_H @@ -57,7 +58,3 @@ /*--------------------------------------------------------------------------------*/ #endif /* UT_OSNETWORK_TEST_H */ - -/*================================================================================* -** End of File: ut_osnetwork_test.h -**================================================================================*/ diff --git a/src/unit-tests/ostimer-test/ut_ostimer_test.h b/src/unit-tests/ostimer-test/ut_ostimer_test.h index 126611d5c..36ca9a956 100644 --- a/src/unit-tests/ostimer-test/ut_ostimer_test.h +++ b/src/unit-tests/ostimer-test/ut_ostimer_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_ostimer_test.h -** Owner: Tam Ngo -** Date: May 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: May 2013 + */ #ifndef UT_OSTIMER_TEST_H #define UT_OSTIMER_TEST_H @@ -57,7 +58,3 @@ /*--------------------------------------------------------------------------------*/ #endif /* UT_OSTIMER_TEST_H */ - -/*================================================================================* -** End of File: ut_ostimer_test.h -**================================================================================*/ diff --git a/src/unit-tests/ostimer-test/ut_ostimer_timerio_test.h b/src/unit-tests/ostimer-test/ut_ostimer_timerio_test.h index eec6a7e94..d4be070b3 100644 --- a/src/unit-tests/ostimer-test/ut_ostimer_timerio_test.h +++ b/src/unit-tests/ostimer-test/ut_ostimer_timerio_test.h @@ -18,11 +18,12 @@ * limitations under the License. */ -/*================================================================================* -** File: ut_ostimer_timerio_test.h -** Owner: Tam Ngo -** Date: April 2013 -**================================================================================*/ +/** + * \file + * + * Owner: Tam Ngo + * Date: April 2013 + */ #ifndef UT_OSTIMER_TIMERIO_TEST_H #define UT_OSTIMER_TIMERIO_TEST_H @@ -65,7 +66,3 @@ void UT_os_timergetinfo_test(void); /*--------------------------------------------------------------------------------*/ #endif /* UT_OSTIMER_TIMERIO_TEST_H */ - -/*================================================================================* -** End of File: ut_ostimer_timerio_test.h -**================================================================================*/ diff --git a/src/ut-stubs/utstub-helpers.h b/src/ut-stubs/utstub-helpers.h index 8ac67a561..029543e6c 100644 --- a/src/ut-stubs/utstub-helpers.h +++ b/src/ut-stubs/utstub-helpers.h @@ -21,9 +21,6 @@ /** * \file utstub-helpers.h * - * Created on: May 24, 2018 - * Author: joseph.p.hickey@nasa.gov - * * Internal header file for OSAL UT stub functions * * The stub implementation can be used for unit testing applications built diff --git a/ut_assert/inc/utassert.h b/ut_assert/inc/utassert.h index a04316431..e583ef859 100644 --- a/ut_assert/inc/utassert.h +++ b/ut_assert/inc/utassert.h @@ -18,8 +18,8 @@ * limitations under the License. */ -/* - * File: utassert.h +/** + * \file * * Purpose: This code implements a standard set of asserts for use in unit tests. * @@ -323,4 +323,4 @@ void UtAssert_DoReport(const char *File, uint32 LineNum, uint32 SegmentNum, uint */ void UtAssert_DoTestSegmentReport(const char *SegmentName, const UtAssert_TestCounter_t *TestCounters); -#endif +#endif /* UTASSERT_H */ diff --git a/ut_assert/inc/utbsp.h b/ut_assert/inc/utbsp.h index 27de86013..35108a16b 100644 --- a/ut_assert/inc/utbsp.h +++ b/ut_assert/inc/utbsp.h @@ -19,10 +19,7 @@ */ /** - * \file utbsp.h - * - * Created on: Feb 25, 2015 - * Author: joseph.p.hickey@nasa.gov + * \file * * Types and definitions for the generic Unit Test BSP interface implemented * as part of OSAL. diff --git a/ut_assert/inc/utlist.h b/ut_assert/inc/utlist.h index e51d1f69b..080f9a926 100644 --- a/ut_assert/inc/utlist.h +++ b/ut_assert/inc/utlist.h @@ -18,8 +18,8 @@ * limitations under the License. */ -/* - * File: utlist.h +/** + * \file * * Purpose: This file contains functions to implement a generic linked list data structure. */ @@ -111,4 +111,4 @@ void *UtList_GetObject(UtListNode_t *ListNode); /* Check if the current node marks the end of the list */ bool UtList_IsEnd(UtListNode_t *TagHead, UtListNode_t *ListNode); -#endif +#endif /* UTLIST_H */ diff --git a/ut_assert/inc/utstubs.h b/ut_assert/inc/utstubs.h index 828be7d2c..aa5c37b2a 100644 --- a/ut_assert/inc/utstubs.h +++ b/ut_assert/inc/utstubs.h @@ -19,10 +19,7 @@ */ /** - * \file utstubs.h - * - * Created on: Feb 25, 2015 - * Author: joseph.p.hickey@nasa.gov + * \file * * Types and definitions for the generic Unit Test Stub framework implemented * as part of OSAL. diff --git a/ut_assert/inc/uttest.h b/ut_assert/inc/uttest.h index d79ac8bee..1e27a1e3f 100644 --- a/ut_assert/inc/uttest.h +++ b/ut_assert/inc/uttest.h @@ -18,8 +18,8 @@ * limitations under the License. */ -/* - * File: uttest.h +/** + * \file * * Purpose: This file contains functions to implement a standard way to execute unit tests. * @@ -100,4 +100,4 @@ void UtTest_Run(void); */ void UtTest_Setup(void); -#endif +#endif /* UTTEST_H */ diff --git a/ut_assert/inc/uttools.h b/ut_assert/inc/uttools.h index 95db31dcd..e69429388 100644 --- a/ut_assert/inc/uttools.h +++ b/ut_assert/inc/uttools.h @@ -18,8 +18,8 @@ * limitations under the License. */ -/* - * File: uttools.h +/** + * \file * * Purpose: This file contains functions to implement a set of tools for use in unit testing. */ @@ -74,4 +74,4 @@ bool UtMem2BinFileCmp(const void *Memory, const char *Filename); #define UtPrintf(...) UtAssert_Message(UTASSERT_CASETYPE_INFO, __FILE__, __LINE__, __VA_ARGS__) #define UtDebug(...) UtAssert_Message(UTASSERT_CASETYPE_DEBUG, __FILE__, __LINE__, __VA_ARGS__) -#endif +#endif /* UTTOOLS_H */ diff --git a/ut_assert/src/utglobal.h b/ut_assert/src/utglobal.h index cc0c08e4c..f1661d12b 100644 --- a/ut_assert/src/utglobal.h +++ b/ut_assert/src/utglobal.h @@ -18,19 +18,18 @@ * limitations under the License. */ -/* - * File: uttest.c +/** + * \file * * Purpose: This file contains functions to implement a standard way to execute unit tests. */ +#ifndef UTGLOBAL_H +#define UTGLOBAL_H + /* * Includes */ - -#ifndef UTASSERT_GLOBAL_H -#define UTASSERT_GLOBAL_H - #include "osapi.h" #include "utassert.h" #include "utlist.h" @@ -64,4 +63,4 @@ typedef struct */ extern UtAssert_Global_t UtAssert_Global; -#endif /* UTASSERT_GLOBAL_H */ +#endif /* UTGLOBAL_H */