Add file descriptions to kernel space headers

cpukit/include/machine/_kernel_cpuset.h

@@ -3,7 +3,8 @@
 /**
  * @file
  *
- *  @brief
+ * @brief This header file provides CPU set definitions for the kernel space
+ *   (_KERNEL is defined before including <sys/cpuset.h>).
  */
 
 /*

cpukit/include/machine/_kernel_in.h

@@ -32,6 +32,13 @@
  * $FreeBSD: head/sys/netinet/in.h 326023 2017-11-20 19:43:44Z pfg $
  */
 
+/**
+ * @file
+ *
+ * @brief This header file provides IPv4 definitions for the kernel space
+ *   (_KERNEL is defined before including <netinet/in.h>).
+ */
+
 #if !defined(_NETINET_IN_H_) || !defined(_KERNEL)
 #error "must be included via <netinet/in.h> in kernel space"
 #endif

cpukit/include/machine/_kernel_in6.h

@@ -31,6 +31,13 @@
  *	$KAME: in6.h,v 1.89 2001/05/27 13:28:35 itojun Exp $
  */
 
+/**
+ * @file
+ *
+ * @brief This header file provides IPv6 definitions for the kernel space
+ *   (_KERNEL is defined before including <netinet6/in6.h>).
+ */
+
 #if !defined(_NETINET6_IN6_H_) || !defined(_KERNEL)
 #error "must be included via <netinet6/in6.h> in kernel space"
 #endif

cpukit/include/machine/_kernel_mman.h

@@ -1,7 +1,13 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
 /**
+ * @file
  *
+ * @brief This header file provides memory map definitions for the kernel space
+ *   (_KERNEL is defined before including <sys/mman.h>).
+ */
+
+/*
  * Copyright (C) 2016 embedded brains GmbH
  *
  * Redistribution and use in source and binary forms, with or without

cpukit/include/machine/_kernel_param.h

@@ -3,7 +3,8 @@
 /**
  * @file
  *
- * @brief
+ * @brief This header file provides parameter definitions for the kernel space
+ *   (_KERNEL is defined before including <sys/param.h>).
  */
 
 /*

cpukit/include/machine/_kernel_time.h

@@ -34,6 +34,13 @@
  * $FreeBSD$
  */
 
+/**
+ * @file
+ *
+ * @brief This header file provides time definitions for the kernel space
+ *   (_KERNEL is defined before including <sys/time.h>).
+ */
+
 #if !defined(_SYS_TIME_H_) || !defined(_KERNEL)
 #error "must be included via <sys/time.h> in kernel space"
 #endif

cpukit/include/machine/_kernel_types.h

@@ -1,5 +1,12 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @brief This header file provides type definitions for the kernel space
+ *   (_KERNEL is defined before including <sys/types.h>).
+ */
+
 /*
  * Copyright (C) 2016 embedded brains GmbH
  *

cpukit/include/machine/_kernel_uio.h

@@ -32,6 +32,13 @@
  * $FreeBSD: head/sys/sys/uio.h 331621 2018-03-27 15:20:03Z brooks $
  */
 
+/**
+ * @file
+ *
+ * @brief This header file provides device driver I/O definitions for the
+ *   kernel space (_KERNEL is defined before including <sys/uio.h>).
+ */
+
 #if !defined(_SYS_UIO_H_) || !defined(_KERNEL)
 #error "must be included via <sys/uio.h> in kernel space"
 #endif

cpukit/include/machine/_timecounter.h

@@ -1,5 +1,12 @@
 /* SPDX-License-Identifier: BSD-2-Clause */
 
+/**
+ * @file
+ *
+ * @brief This header file provides timecounter definitions for the kernel space
+ *   (_KERNEL is defined before including <sys/time.h>) and RTEMS.
+ */
+
 /*
  * Copyright (C) 2016 embedded brains GmbH
  *