Merge pull request #103 from skliper/fix102-header_guard

Fix #102, Apply header guard standard
nasa · Feb 24, 2022 · 94273c3 · 94273c3
2 parents 2c5f250 + 1836ede
commit 94273c3
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 84 deletions.
diff --git a/fsw/mission_inc/ci_lab_perfids.h b/fsw/mission_inc/ci_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: ci_lab_perfids.h
-**
-** Purpose:
-**  Define CI Lab Performance IDs
-**
-** Notes:
-**
-*************************************************************************/
-#ifndef _ci_lab_perfids_h_
-#define _ci_lab_perfids_h_
+*/
+
+/**
+ * @file
+ *   Define CI Lab Performance IDs
+ */
+#ifndef CI_LAB_PERFIDS_H
+#define CI_LAB_PERFIDS_H
 
 #define CI_LAB_MAIN_TASK_PERF_ID  32
 #define CI_LAB_SOCKET_RCV_PERF_ID 33
 
-#endif /* _ci_lab_perfids_h_ */
-
-/************************/
-/*  End of File Comment */
-/************************/
+#endif
diff --git a/fsw/platform_inc/ci_lab_msgids.h b/fsw/platform_inc/ci_lab_msgids.h
@@ -17,25 +17,18 @@
 **      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: ci_lab_msgids.h
-**
-** Purpose:
-**  Define CI Lab Message IDs
-**
-** Notes:
-**
-*************************************************************************/
-#ifndef _ci_lab_msgids_h_
-#define _ci_lab_msgids_h_
+*/
+
+/**
+ * @file
+ *   Define CI Lab Message IDs
+ */
+#ifndef CI_LAB_MSGIDS_H
+#define CI_LAB_MSGIDS_H
 
 #define CI_LAB_CMD_MID     0x1884
 #define CI_LAB_SEND_HK_MID 0x1885
 
 #define CI_LAB_HK_TLM_MID 0x0884
 
-#endif /* _ci_lab_msgids_h_ */
-
-/************************/
-/*  End of File Comment */
-/************************/
+#endif
diff --git a/fsw/src/ci_lab_app.h b/fsw/src/ci_lab_app.h
@@ -17,16 +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: ci_lab_app.h
-**
-** Purpose:
-**   This file is main hdr file for the Command Ingest lab application.
-**
-*******************************************************************************/
+*/
 
-#ifndef _ci_lab_app_h_
-#define _ci_lab_app_h_
+/**
+ * @file
+ *   This file is main hdr file for the Command Ingest lab application.
+ */
+#ifndef CI_LAB_APP_H
+#define CI_LAB_APP_H
 
 /*
 ** Required header files...
@@ -66,4 +64,4 @@ void CI_LAB_ReadUpLink(void);
 
 bool CI_LAB_VerifyCmdLength(CFE_MSG_Message_t *MsgPtr, size_t ExpectedLength);
 
-#endif /* _ci_lab_app_h_ */
+#endif
diff --git a/fsw/src/ci_lab_events.h b/fsw/src/ci_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: ci_lab_events.h
-**
-** Purpose:
-**  Define CI Lab Events IDs
-**
-** Notes:
-**
-*************************************************************************/
-#ifndef _ci_lab_events_h_
-#define _ci_lab_events_h_
+*/
+
+/**
+ * @file
+ *  Define CI Lab Events IDs
+ */
+#ifndef CI_LAB_EVENTS_H
+#define CI_LAB_EVENTS_H
 
 #define CI_LAB_RESERVED_EID         0
 #define CI_LAB_SOCKETCREATE_ERR_EID 1
@@ -42,8 +39,4 @@
 #define CI_LAB_INGEST_SEND_ERR_EID  10
 #define CI_LAB_LEN_ERR_EID          16
 
-#endif /* _ci_lab_events_h_ */
-
-/************************/
-/*  End of File Comment */
-/************************/
+#endif
diff --git a/fsw/src/ci_lab_msg.h b/fsw/src/ci_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: ci_lab_msg.h
-**
-** Purpose:
-**  Define CI Lab Messages and info
-**
-** Notes:
-**
-*******************************************************************************/
-#ifndef _ci_lab_msg_h_
-#define _ci_lab_msg_h_
+*/
+
+/**
+ * @file
+ *  Define CI Lab Messages and info
+ */
+#ifndef CI_LAB_MSG_H
+#define CI_LAB_MSG_H
 
 /*
 ** CI_LAB command codes
@@ -78,8 +75,4 @@ typedef struct
     CI_LAB_HkTlm_Payload_t    Payload;
 } CI_LAB_HkTlm_t;
 
-#endif /* _ci_lab_msg_h_ */
-
-/************************/
-/*  End of File Comment */
-/************************/
+#endif
diff --git a/fsw/src/ci_lab_version.h b/fsw/src/ci_lab_version.h
@@ -20,13 +20,10 @@
 **
 *************************************************************************/
 
-/*! @file ci_lab_version.h
- * @brief Purpose:
- *
+/**
+ * @file
  *  The CI Lab App header file containing version information
- *
  */
-
 #ifndef CI_LAB_VERSION_H
 #define CI_LAB_VERSION_H
 
@@ -67,8 +64,4 @@
     " CI Lab App DEVELOPMENT BUILD " CI_LAB_VERSION \
     ", Last Official Release: v2.3.0" /* For full support please use this version */
 
-#endif /* CI_LAB_VERSION_H */
-
-/************************/
-/*  End of File Comment */
-/************************/
+#endif