-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix nasa#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.
- Loading branch information
Showing
53 changed files
with
6,902 additions
and
3,884 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 */ |
Oops, something went wrong.