Fix #20, major doxygen documentation update

Make sure _all_ functions in CF have a doxygen block on the declaration
describing the inputs and outputs and a general summary of what the function does.

Additionally describe the purpose of structures and structure members where
it is not totally obvious from the name.

Note: this also renames one member, CF_max_chunks, that appears to have been
improperly scooped up in a previous batch rename.

fsw/mission_inc/cf_perfids.h

@@ -1,32 +1,31 @@
 /************************************************************************
-** File: cf_perfids.h
-**
-**
-** NASA Docket No. GSC-18,447-1, and identified as “CFS CFDP (CF)
-** Application version 3.0.0”
-** Copyright © 2019 United States Government as represented by the
-** Administrator of the National Aeronautics and Space Administration.
-** All Rights Reserved.
-** Licensed under the Apache License, Version 2.0 (the "License"); you may
-** not use this file except in compliance with the License. You may obtain
-** a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
-**
-** Unless required by applicable law or agreed to in writing, software
-** distributed under the License is distributed on an "AS IS" BASIS,
-** 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.
-**
-**
-** Purpose:
-**  Define CF Performance IDs
-**
-**
-**
-**
-*************************************************************************/
-#ifndef _CF_PERFIDS_H_
-#define _CF_PERFIDS_H_
+ *
+ * NASA Docket No. GSC-18,447-1, and identified as “CFS CFDP (CF)
+ * Application version 3.0.0”
+ * Copyright © 2019 United States Government as represented by the
+ * Administrator of the National Aeronautics and Space Administration.
+ * All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * 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
+ *
+ *  Define CF Performance IDs
+ */
+
+#ifndef CF_PERFIDS_H
+#define CF_PERFIDS_H
 
 #define CF_PERF_ID_APPMAIN    11
 #define CF_PERF_ID_FSEEK      12
@@ -41,7 +40,7 @@
 #define CF_PERF_ID_PDURCVD(x) (30 + x)
 #define CF_PERF_ID_PDUSENT(x) (40 + x)
 
-#endif /* !_CF_PERFIDS_H_ */
+#endif /* !CF_PERFIDS_H */
 
 /************************/
 /*  End of File Comment */

fsw/platform_inc/cf_msgids.h

@@ -1,44 +1,45 @@
 /************************************************************************
-** File: cf_msgids.h
-**
-** NASA Docket No. GSC-18,447-1, and identified as “CFS CFDP (CF)
-** Application version 3.0.0”
-** Copyright © 2019 United States Government as represented by the
-** Administrator of the National Aeronautics and Space Administration.
-** All Rights Reserved.
-** Licensed under the Apache License, Version 2.0 (the "License"); you may
-** not use this file except in compliance with the License. You may obtain
-** a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
-**
-** Unless required by applicable law or agreed to in writing, software
-** distributed under the License is distributed on an "AS IS" BASIS,
-** 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.
-**
-**
-** Purpose:
-**  The CF Application Message IDs header file
-**
-**
-**
-*************************************************************************/
-#ifndef _CF_MSGIDS_H_
-#define _CF_MSGIDS_H_
+ *
+ * NASA Docket No. GSC-18,447-1, and identified as “CFS CFDP (CF)
+ * Application version 3.0.0”
+ * Copyright © 2019 United States Government as represented by the
+ * Administrator of the National Aeronautics and Space Administration.
+ * All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License. You may obtain
+ * a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * 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
+ *
+ *  The CF Application Message IDs header file
+ */
+
+#ifndef CF_MSGIDS_H
+#define CF_MSGIDS_H
 
 /**************************
-** CF Command Message IDs
-***************************/
+ * CF Command Message IDs
+ **************************/
 
 #define CF_CMD_MID     0x18B3
 #define CF_SEND_HK_MID 0x18B4
 #define CF_WAKE_UP_MID 0x18B5
 
 /***************************
-** CF Telemetry Message IDs
-****************************/
+ * CF Telemetry Message IDs
+ ***************************/
 
 #define CF_HK_TLM_MID     0x08B0
 #define CF_CONFIG_TLM_MID 0x08B2
 
-#endif /* !_CF_MSGIDS_H_ */
+#endif /* !CF_MSGIDS_H */