Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #1239, scrub include header guards #1262

Merged
merged 2 commits into from
Mar 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions cmake/sample_defs/cpu1_msgids.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,23 @@
** limitations under the License.
*/

/******************************************************************************
** File: cfe_msgids.h
**
** Purpose:
** This header file contains the Message Id's for messages used by the
** cFE core.
**
** Author: R.McGraw/SSI
**
** Notes:
** This file should not contain messages defined by cFE external
** applications.
**
******************************************************************************/
#ifndef _cfe_msgids_
#define _cfe_msgids_
/**
* @file
*
* Purpose:
* This header file contains the Message Id's for messages used by the
* cFE core.
*
* Author: R.McGraw/SSI
*
* Notes:
* This file should not contain messages defined by cFE external
* applications.
*
*/

#ifndef CPU1_MSGIDS_H
#define CPU1_MSGIDS_H

/*
** Includes
Expand Down Expand Up @@ -129,4 +130,4 @@
#define CFE_SB_ONESUB_TLM_MID CFE_PLATFORM_TLM_MID_BASE + CFE_MISSION_SB_ONESUB_TLM_MSG /* 0x080E */
#define CFE_ES_MEMSTATS_TLM_MID CFE_PLATFORM_TLM_MID_BASE + CFE_MISSION_ES_MEMSTATS_TLM_MSG /* 0x0810 */

#endif
#endif /* CPU1_MSGIDS_H */
34 changes: 17 additions & 17 deletions cmake/sample_defs/cpu1_platform_cfg.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,23 @@
** limitations under the License.
*/

/******************************************************************************
** File: cfe_platform_cfg.h
**
** Purpose:
** This header file contains the platform configuration parameters.
**
** Notes:
** The impact of changing these configurations from their default value is
** not yet documented. Changing these values may impact the performance
** and functionality of the system.
**
** Author: R.McGraw/SSI
**
******************************************************************************/
/**
* @file
*
* Purpose:
* This header file contains the platform configuration parameters.
*
* Notes:
* The impact of changing these configurations from their default value is
* not yet documented. Changing these values may impact the performance
* and functionality of the system.
*
* Author: R.McGraw/SSI
*
*/

#ifndef _cfe_platform_cfg_
#define _cfe_platform_cfg_
#ifndef CPU1_PLATFORM_CFG_H
#define CPU1_PLATFORM_CFG_H

/**
** \cfeescfg Default virtual path for persistent storage
Expand Down Expand Up @@ -1708,4 +1708,4 @@
*/
#define CFE_PLATFORM_ES_STARTUP_SCRIPT_TIMEOUT_MSEC 1000

#endif /* _cfe_platform_cfg_ */
#endif /* CPU1_PLATFORM_CFG_H */
42 changes: 19 additions & 23 deletions cmake/sample_defs/sample_mission_cfg.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,24 @@
** limitations under the License.
*/

/******************************************************************************
** File: cfe_mission_cfg.h
**
** Purpose:
** This header file contains the mission configuration parameters and
** typedefs with mission scope.
**
** Notes:
** The impact of changing these configurations from their default value is
** not yet documented. Changing these values may impact the performance
** and functionality of the system.
**
** Author: R.McGraw/SSI
**
******************************************************************************/

#ifndef _cfe_mission_cfg_
#define _cfe_mission_cfg_
/**
* @file
*
* Purpose:
* This header file contains the mission configuration parameters and
* typedefs with mission scope.
*
* Notes:
* The impact of changing these configurations from their default value is
* not yet documented. Changing these values may impact the performance
* and functionality of the system.
*
* Author: R.McGraw/SSI
*
*/

#ifndef SAMPLE_MISSION_CFG_H
#define SAMPLE_MISSION_CFG_H

/**
** \cfesbcfg Maximum SB Message Size
Expand Down Expand Up @@ -65,7 +65,6 @@
** format. This avoids having to modify each individual caller
** when the default choice is changed.
**
**
** \par Limits
** if CFE_MISSION_TIME_CFG_DEFAULT_TAI is defined as true then CFE_MISSION_TIME_CFG_DEFAULT_UTC must be
** defined as false.
Expand All @@ -82,7 +81,6 @@
** The following definition enables the use of a simulated time at
** the tone signal using a software bus message.
**
**
** \par Limits
** Not Applicable
*/
Expand Down Expand Up @@ -131,7 +129,6 @@
**
** Note: units are in micro-seconds
**
**
** \par Limits
** 0 to 999,999 decimal
*/
Expand Down Expand Up @@ -421,7 +418,6 @@
** anticipated to be reasonably small (i.e. tens, not hundreds). Large
** values have not been tested.
**
**
*/
#define CFE_MISSION_ES_POOL_MAX_BUCKETS 17

Expand Down Expand Up @@ -562,4 +558,4 @@
*/
#define CFE_MISSION_ES_CDS_MAX_FULL_NAME_LEN (CFE_MISSION_ES_CDS_MAX_NAME_LENGTH + CFE_MISSION_MAX_API_LEN + 4)

#endif /* _cfe_mission_cfg_ */
#endif /* SAMPLE_MISSION_CFG_H */
38 changes: 19 additions & 19 deletions cmake/sample_defs/sample_perfids.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,24 @@
** limitations under the License.
*/

/*
** File: cfe_perfids.h
**
** Purpose: This file contains the cFE performance IDs
**
** Design Notes:
** Each performance id is used to identify something that needs to be
** measured. Performance ids are limited to the range of 0 to
** CFE_MISSION_ES_PERF_MAX_IDS - 1. Any performance ids outside of this range
** will be ignored and will be flagged as an error. Note that
** performance ids 0-31 are reserved for the cFE Core.
**
** References:
**
*/

#ifndef _cfe_perfids_
#define _cfe_perfids_
/**
* @file
*
* Purpose: This file contains the cFE performance IDs
*
* Design Notes:
* Each performance id is used to identify something that needs to be
* measured. Performance ids are limited to the range of 0 to
* CFE_MISSION_ES_PERF_MAX_IDS - 1. Any performance ids outside of this range
* will be ignored and will be flagged as an error. Note that
* performance ids 0-31 are reserved for the cFE Core.
*
* References:
*
*/

#ifndef SAMPLE_PERFIDS_H
#define SAMPLE_PERFIDS_H

#define CFE_MISSION_ES_PERF_EXIT_BIT 31 /**< \brief bit (31) is reserved by the perf utilities */

Expand All @@ -58,4 +58,4 @@

/** \} */

#endif /* _cfe_perfids_ */
#endif /* SAMPLE_PERFIDS_H */
11 changes: 4 additions & 7 deletions cmake/target/inc/target_config.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@
*/

/**
* \file target_config.h
*
* Created on: Dec 12, 2014
* Created by: joseph.p.hickey@nasa.gov
* @file
*
* Defines structures for the global system-wide configuration data.
* These structures can be accessed at runtime and are an alternative to
Expand All @@ -31,8 +28,8 @@
* code becomes more portable.
*/

#ifndef TARGET_CONFIG_H_
#define TARGET_CONFIG_H_
#ifndef TARGET_CONFIG_H
#define TARGET_CONFIG_H

#include "common_types.h"
#include "cfe_psp_configdata.h"
Expand Down Expand Up @@ -213,4 +210,4 @@ typedef const struct
*/
extern Target_ConfigData GLOBAL_CONFIGDATA;

#endif /* TARGET_CONFIG_H_ */
#endif /* TARGET_CONFIG_H */
18 changes: 10 additions & 8 deletions modules/cfe_assert/inc/cfe_assert.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,15 @@
** Specification for the CFE assert (UT assert wrapper) functions.
**
*************************************************************************/
#ifndef cfe_assert_h_
#define cfe_assert_h_

/**
* @file
*
* Declarations and prototypes for cfe_assert module
*/

#ifndef CFE_ASSERT_H
#define CFE_ASSERT_H

/************************************************************************
** Includes
Expand All @@ -52,12 +59,7 @@
**
** \return Execution status, see \ref CFEReturnCodes
**
**
*************************************************************************/
void CFE_Assert_AppMain(void);

#endif /* cfe_assert_h_ */

/************************/
/* End of File Comment */
/************************/
#endif /* CFE_ASSERT_H */
7 changes: 6 additions & 1 deletion modules/cfe_testcase/src/cfe_test.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,18 @@
**
*************************************************************************/

/**
* @file
*
* Declarations and prototypes for cfe_test module
*/

#ifndef CFE_TEST_H
#define CFE_TEST_H

/*
* Includes
*/

#include "cfe.h"

#include "uttest.h"
Expand Down
18 changes: 10 additions & 8 deletions modules/cfe_testrunner/inc/cfe_testrunner.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,15 @@
** Specification for the CFE testrunner (UT testrunner wrapper) functions.
**
*************************************************************************/
#ifndef cfe_testrunner_h_
#define cfe_testrunner_h_

/**
* @file
*
* Declarations and prototypes for cfe_testrunner module
*/

#ifndef CFE_TESTRUNNER_H
#define CFE_TESTRUNNER_H

/************************************************************************
** Includes
Expand All @@ -52,12 +59,7 @@
**
** \return Execution status, see \ref CFEReturnCodes
**
**
*************************************************************************/
void CFE_TestRunner_AppMain(void);

#endif /* cfe_testrunner_h_ */

/************************/
/* End of File Comment */
/************************/
#endif /* CFE_TESTRUNNER_H */
29 changes: 12 additions & 17 deletions modules/core_api/fsw/inc/cfe.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,19 @@
** limitations under the License.
*/

/*
** File: cfe.h
**
** Purpose: cFE header file
**
** Author: David Kobe, the Hammers Company, Inc.
**
** Notes: This header file centralizes the includes for all cFE
** Applications. It includes all header files necessary
** to completely define the cFE interface.
**
*/

/*************************************************************************/
/**
* @file
*
* Purpose: cFE header file
*
* Author: David Kobe, the Hammers Company, Inc.
*
* Notes: This header file centralizes the includes for all cFE
* Applications. It includes all header files necessary
* to completely define the cFE interface.
*
*/

/*
** Ensure that header is included only once...
*/
#ifndef CFE_H
#define CFE_H

Expand Down
14 changes: 7 additions & 7 deletions modules/core_api/fsw/inc/cfe_endian.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@
** limitations under the License.
*/

/******************************************************************************
** File: cfe_endian.h
**
** Purpose:
** Define macros to enforce big-endian/network byte order for 16 and 32 bit integers
**
******************************************************************************/
/**
* @file
*
* Purpose:
* Define macros to enforce big-endian/network byte order for 16 and 32 bit integers
*
*/

#ifndef CFE_ENDIAN_H
#define CFE_ENDIAN_H
Expand Down
Loading