Fix #113, Apply header guard standard

nasa · Feb 4, 2022 · 88505ee · 88505ee
1 parent c6580d4
commit 88505ee
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 96 deletions.
diff --git a/fsw/mission_inc/to_lab_perfids.h b/fsw/mission_inc/to_lab_perfids.h
@@ -17,23 +17,16 @@
 **      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 **      See the License for the specific language governing permissions and
 **      limitations under the License.
-**
-** File: to_lab_perfids.h
-**
-** Purpose:
-**  Define TO Lab Performance IDs
-**
-** Notes:
-**
-*************************************************************************/
-#ifndef _to_lab_perfids_h_
-#define _to_lab_perfids_h_
+*/
+
+/**
+ * @file
+ *   Define TO Lab Performance IDs
+ */
+#ifndef TO_LAB_PERFIDS_H
+#define TO_LAB_PERFIDS_H
 
 #define TO_MAIN_TASK_PERF_ID   34
 #define TO_SOCKET_SEND_PERF_ID 35
 
-#endif /* _to_lab_perfids_h_ */
-
-/************************/
-/*  End of File Comment */
-/************************/
+#endif
diff --git a/fsw/platform_inc/to_lab_msgids.h b/fsw/platform_inc/to_lab_msgids.h
@@ -17,26 +17,19 @@
 **      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 **      See the License for the specific language governing permissions and
 **      limitations under the License.
-**
-** File: to_lab_msgids.h
-**
-** Purpose:
-**  Define TO Lab Message IDs
-**
-** Notes:
-**
-*************************************************************************/
-#ifndef _to_lab_msgids_h_
-#define _to_lab_msgids_h_
+*/
+
+/**
+ * @file
+ *   Define TO Lab Message IDs
+ */
+#ifndef TO_LAB_MSGIDS_H
+#define TO_LAB_MSGIDS_H
 
 #define TO_LAB_CMD_MID     0x1880
 #define TO_LAB_SEND_HK_MID 0x1881
 
 #define TO_LAB_HK_TLM_MID     0x0880
 #define TO_LAB_DATA_TYPES_MID 0x0881
 
-#endif /* _to_lab_msgids_h_ */
-
-/************************/
-/*  End of File Comment */
-/************************/
+#endif
diff --git a/fsw/platform_inc/to_lab_sub_table.h b/fsw/platform_inc/to_lab_sub_table.h
@@ -17,17 +17,14 @@
 **      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 **      See the License for the specific language governing permissions and
 **      limitations under the License.
-**
-** File: to_lab_sub_table.h
-**
-** Purpose:
-**  Define TO Lab CPU specific subscription table
-**
-** Notes:
-**
-*************************************************************************/
-#ifndef to_lab_sub_table_h_
-#define to_lab_sub_table_h_
+*/
+
+/**
+ * @file
+ *   Define TO Lab CPU specific subscription table
+ */
+#ifndef TO_LAB_SUB_TABLE_H
+#define TO_LAB_SUB_TABLE_H
 
 #include "cfe_msgids.h"
 #include "cfe_platform_cfg.h"
@@ -45,4 +42,4 @@ typedef struct
     TO_LAB_Sub_t Subs[CFE_PLATFORM_SB_MAX_MSG_IDS];
 } TO_LAB_Subs_t;
 
-#endif /* to_lab_sub_table_h_ */
+#endif
diff --git a/fsw/src/to_lab_app.h b/fsw/src/to_lab_app.h
@@ -17,18 +17,15 @@
 **      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 **      See the License for the specific language governing permissions and
 **      limitations under the License.
-**
-** File: to_lab_app.h
-**
-** Purpose:
-**  Define TO Lab Application header file
-**
-** Notes:
-**
-*************************************************************************/
+*/
+
+/**
+ * @file
+ *   Define TO Lab Application header file
+ */
 
-#ifndef _to_lab_app_h_
-#define _to_lab_app_h_
+#ifndef TO_LAB_APP_H
+#define TO_LAB_APP_H
 
 #include "cfe.h"
 
@@ -67,4 +64,4 @@ void TO_Lab_AppMain(void);
 
 /******************************************************************************/
 
-#endif /* _to_lab_app_h_ */
+#endif
diff --git a/fsw/src/to_lab_events.h b/fsw/src/to_lab_events.h
@@ -17,17 +17,14 @@
 **      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 **      See the License for the specific language governing permissions and
 **      limitations under the License.
-**
-** File: to_lab_events.h
-**
-** Purpose:
-**  Define TO Lab Event messages
-**
-** Notes:
-**
-*************************************************************************/
-#ifndef _to_lab_events_h_
-#define _to_lab_events_h_
+*/
+
+/**
+ * @file
+ *   Define TO Lab Event messages
+ */
+#ifndef TO_LAB_EVENTS_H
+#define TO_LAB_EVENTS_H
 
 /*****************************************************************************/
 
@@ -54,4 +51,4 @@
 
 /******************************************************************************/
 
-#endif /* _to_lab_events_h_ */
+#endif
diff --git a/fsw/src/to_lab_msg.h b/fsw/src/to_lab_msg.h
@@ -17,17 +17,14 @@
 **      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 **      See the License for the specific language governing permissions and
 **      limitations under the License.
-**
-** File: to_lab_msg.h
-**
-** Purpose:
-**  Define TO Lab Messages and info
-**
-** Notes:
-**
-*************************************************************************/
-#ifndef _to_lab_msg_h_
-#define _to_lab_msg_h_
+*/
+
+/**
+ * @file
+ *   Define TO Lab Messages and info
+ */
+#ifndef TO_LAB_MSG_H
+#define TO_LAB_MSG_H
 
 #define TO_NOP_CC             0 /*  no-op command     */
 #define TO_RESET_STATUS_CC    1 /*  reset status      */
@@ -152,8 +149,4 @@ typedef struct
 
 /******************************************************************************/
 
-#endif /* _to_lab_msg_h_ */
-
-/************************/
-/*  End of File Comment */
-/************************/
+#endif
diff --git a/fsw/src/to_lab_version.h b/fsw/src/to_lab_version.h
@@ -20,15 +20,12 @@
 **
 *************************************************************************/
 
-#ifndef TO_LAB_VERSION_H
-#define TO_LAB_VERSION_H
-
-/*! @file to_lab_version.h
- * @brief Purpose:
- *
+/**
+ * @file
  *  The TO Lab Application header file containing version information
- *
  */
+#ifndef TO_LAB_VERSION_H
+#define TO_LAB_VERSION_H
 
 /* Development Build Macro Definitions */
 #define TO_LAB_BUILD_NUMBER 4 /*!< Development Build: Number of commits since baseline */
@@ -66,8 +63,4 @@
     " TO Lab DEVELOPMENT BUILD " TO_LAB_VERSION \
     ", Last Official Release: v2.3.0" /* For full support please use this version */
 
-#endif /* TO_LAB_VERSION_H */
-
-/************************/
-/*  End of File Comment */
-/************************/
+#endif