Fix a few errors concerning use of section block comments in .c files: (

#95) 1. No .c file should include a "Public Types" section. Only a header file can define a public type. A .c file can only define a private type. Several files contained private type definitions. The section that they were defined in, however, was incorrectly named "Public Types." Those were easilty changed to "Private Types" which is what they are. 2. No .c file should include a "Public Function Prototypes" section. All global function prototypes should be provided via a header file and never declared with a .c file. For No. 2, I corrected as many cases as was reasonable for the time that I had available. But there are still a dozen or so .c files that declare "Public Function Prototypes" within a .c file. This is bad programming style. These declarations should all be moved to the proper header files.
PX4 · Jan 13, 2020 · f005698 · f005698
1 parent f8bcd58
commit f005698
Show file tree

Hide file tree

Showing 33 changed files with 71 additions and 234 deletions.
diff --git a/arch/arm/src/cxd56xx/cxd56_dmac.c b/arch/arm/src/cxd56xx/cxd56_dmac.c
@@ -269,7 +269,7 @@ static int (*intc_handler[])(int irq, FAR void *context, FAR void *arg) = {
 };
 
 /****************************************************************************
- * Public Types
+ * Private Types
  ****************************************************************************/
 
 /* This structure describes one DMA channel */

diff --git a/arch/arm/src/cxd56xx/cxd56_udmac.c b/arch/arm/src/cxd56xx/cxd56_udmac.c
@@ -65,7 +65,7 @@
 #define ALIGN_UP(v, m)   (((v) + (m)) & ~m)
 
 /****************************************************************************
- * Public Types
+ * Private Types
  ****************************************************************************/
 
 /* This structure describes one DMA channel */

diff --git a/arch/arm/src/efm32/efm32_dma.c b/arch/arm/src/efm32/efm32_dma.c
@@ -63,8 +63,9 @@
 #define ALIGN_UP(v,m)   (((v) + (m)) & ~m)
 
 /****************************************************************************
- * Public Types
+ * Private Types
  ****************************************************************************/
+
 /* This structure describes one DMA channel */
 
 struct dma_channel_s

diff --git a/arch/arm/src/efm32/efm32_gpioirq.c b/arch/arm/src/efm32/efm32_gpioirq.c
@@ -152,7 +152,7 @@ static int efm32_odd_interrupt(int irq, void *context, FAR void *arg)
 }
 
 /************************************************************************************
- * Public Function Prototypes
+ * Public Functions
  ************************************************************************************/
 
 /************************************************************************************

diff --git a/arch/arm/src/imx1/imx_boot.c b/arch/arm/src/imx1/imx_boot.c
@@ -102,7 +102,7 @@ static const struct section_mapping_s section_mapping[] =
  ************************************************************************************/
 
 /* All i.MX architectures must provide the following entry point.  This entry point
- * is called early in the intitialization -- after all memory has been configured
+ * is called early in the initialization -- after all memory has been configured
  * and mapped but before any devices have been initialized.
  */
 

diff --git a/arch/arm/src/stm32/stm32_ccm.c b/arch/arm/src/stm32/stm32_ccm.c
@@ -51,7 +51,7 @@
 struct mm_heap_s g_ccm_heap;
 
 /****************************************************************************
- * Public Function Prototypes
+ * Public Functions
  ****************************************************************************/
 
 #endif /* HAVE_CCM_HEAP */
diff --git a/arch/arm/src/stm32f7/stm32_dtcm.c b/arch/arm/src/stm32f7/stm32_dtcm.c
@@ -43,22 +43,14 @@
 
 #ifdef HAVE_DTCM_HEAP
 
-/****************************************************************************
- * Pre-processor Definitions
- ****************************************************************************/
-
-/****************************************************************************
- * Private Types
- ****************************************************************************/
-
 /****************************************************************************
  * Public Data
  ****************************************************************************/
 
 struct mm_heap_s g_dtcm_heap;
 
 /****************************************************************************
- * Public Function Prototypes
+ * Public Functions
  ****************************************************************************/
 
 #endif /* HAVE_DTCM_HEAP */
diff --git a/arch/hc/src/m9s12/m9s12_dumpgpio.c b/arch/hc/src/m9s12/m9s12_dumpgpio.c
@@ -110,7 +110,7 @@
 #define MEBIPORT_K   2
 
 /****************************************************************************
- * Public Types
+ * Private Types
  ****************************************************************************/
 
 struct gpio_piminfo_s

diff --git a/arch/renesas/src/rx65n/rx65n_eth.c b/arch/renesas/src/rx65n/rx65n_eth.c
@@ -386,7 +386,7 @@
 #define NX_ALIGN32 __attribute__((aligned(32)))
 
 /****************************************************************************
- * Public Types
+ * Private Types
  ****************************************************************************/
 
 /* Ethernet TX DMA Descriptor */

diff --git a/arch/sim/src/sim/up_testset.c b/arch/sim/src/sim/up_testset.c
@@ -43,14 +43,16 @@
 /****************************************************************************
  * Pre-processor Definitions
  ****************************************************************************/
+
 /* Must match definitions in arch/sim/include/spinlock.h */
 
 #define SP_UNLOCKED 0   /* The Un-locked state */
 #define SP_LOCKED   1   /* The Locked state */
 
 /****************************************************************************
- * Public Types
+ * Private Types
  ****************************************************************************/
+
 /* Must match definitions in arch/sim/include/spinlock.h */
 
 typedef uint8_t spinlock_t;

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio.c
@@ -66,10 +66,6 @@
 #define AUDIO_DNC_ID_NUM      (CXD56_AUDIO_DNC_ID_FF + 1)
 #define AUDIO_VOL_ID_NUM      (CXD56_AUDIO_VOLID_MIXER_OUT + 1)
 
-/***************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
-
 /***************************************************************************
  * Private Types
  ****************************************************************************/

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio_ac_reg.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio_ac_reg.c
@@ -114,10 +114,6 @@
 #define SRCIN_SEL_AU_DAT_SEL2  1
 #define SRCIN_SEL_CODECDSP_MIX 3
 
-/****************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
-
 /****************************************************************************
  * Private Data
  ****************************************************************************/
@@ -449,10 +445,6 @@ const struct audio_ac_reg_s g_ac_reg[RI_REG_MAX_ENTRY] =
   {0x0780,  0,  1, 0x00000000},  /* RAM_RW_EN (0x00) */
 };
 
-/****************************************************************************
- * Public Data
- ****************************************************************************/
-
 /****************************************************************************
  * Private Functions
  ****************************************************************************/

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio_aca.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio_aca.c
@@ -356,14 +356,6 @@ typedef enum
 
 extern uint32_t as_aca_control(uint8_t type, uint32_t param);
 
-/****************************************************************************
- * Private Data
- ****************************************************************************/
-
-/****************************************************************************
- * Public Data
- ****************************************************************************/
-
 /****************************************************************************
  * Private Functions
  ****************************************************************************/

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio_analog.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio_analog.c
@@ -64,9 +64,9 @@
  * Public Function Prototypes
  ****************************************************************************/
 
-  inline void cxd56_audio_clock_enable(uint32_t clk, uint32_t div);
-  inline void cxd56_audio_clock_disable(void);
-  inline bool cxd56_audio_clock_is_enabled(void);
+inline void cxd56_audio_clock_enable(uint32_t clk, uint32_t div);
+inline void cxd56_audio_clock_disable(void);
+inline bool cxd56_audio_clock_is_enabled(void);
 
 /****************************************************************************
  * Private Data

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio_bca_reg.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio_bca_reg.c
@@ -70,14 +70,6 @@ enum dma_i2s_out_sel_e
 
 #define BCA_REG_MAX_BIT 32
 
-/***************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
-
-/***************************************************************************
- * Private Data
- ****************************************************************************/
-
 /***************************************************************************
  * Public Data
  ****************************************************************************/

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio_beep.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio_beep.c
@@ -63,10 +63,6 @@
 
 #define VOL_MIN         -90
 
-/***************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
-
 /***************************************************************************
  * Private Data
  ****************************************************************************/
@@ -83,10 +79,6 @@ static const uint16_t g_beepfreqtable[] =
   3840, 4085,   94
 };
 
-/***************************************************************************
- * Public Data
- ****************************************************************************/
-
 /***************************************************************************
  * Private Functions
  ****************************************************************************/

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio_config.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio_config.c
@@ -47,10 +47,6 @@
 #define MIC_CH_BITNUM  4
 #define MIC_CH_BITMAP  0xf
 
-/****************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
-
 /****************************************************************************
  * Private Data
  ****************************************************************************/
@@ -64,6 +60,7 @@ struct cxd56_audio_cfg_s
   cxd56_audio_clkmode_t clk_mode;
   cxd56_audio_sp_drv_t  sp_driver;
 };
+
 static struct cxd56_audio_cfg_s g_audio_cfg =
 {
   1,
@@ -74,10 +71,6 @@ static struct cxd56_audio_cfg_s g_audio_cfg =
   CXD56_AUDIO_CFG_SP_DRIVER
 };
 
-/****************************************************************************
- * Public Data
- ****************************************************************************/
-
 /****************************************************************************
  * Private Functions
  ****************************************************************************/

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio_digital.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio_digital.c
@@ -45,26 +45,6 @@
 #include "cxd56_audio_bca_reg.h"
 #include "cxd56_audio_digital.h"
 
-/***************************************************************************
- * Pre-processor Definitions
- ****************************************************************************/
-
-/***************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
-
-/***************************************************************************
- * Private Data
- ****************************************************************************/
-
-/***************************************************************************
- * Public Data
- ****************************************************************************/
-
-/***************************************************************************
- * Private Functions
- ****************************************************************************/
-
 /***************************************************************************
  * Public Functions
  ****************************************************************************/

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio_dma.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio_dma.c
@@ -92,9 +92,11 @@ enum audio_irq_reg_type_e
 #define DMA_SMP_WAIT_HIRES   10 /* usec per sample. */
 #define DMA_SMP_WAIT_NORMALT 40 /* usec per sample. */
 
-/***************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
+/* Private Macros */
+
+#define SET_DMA_ACT(_path_)  g_dma_act_status |= (1 << _path_)
+#define CLR_DMA_ACT(_path_)  g_dma_act_status &= ~(1 << _path_)
+#define IS_DMA_ACT(_path_)   ((g_dma_act_status & (1 << _path_)) != 0)
 
 /***************************************************************************
  * Private Data
@@ -110,18 +112,6 @@ static bool s_work_arroud_dmac[DMA_HANDLE_MAX_NUM] =
   true
 };
 
-/***************************************************************************
- * Private Macro
- ****************************************************************************/
-
-#define SET_DMA_ACT(_path_)  g_dma_act_status |= (1 << _path_)
-#define CLR_DMA_ACT(_path_)  g_dma_act_status &= ~(1 << _path_)
-#define IS_DMA_ACT(_path_)   ((g_dma_act_status & (1 << _path_)) != 0)
-
-/***************************************************************************
- * Public Data
- ****************************************************************************/
-
 /***************************************************************************
  * Private Functions
  ****************************************************************************/

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio_filter.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio_filter.c
@@ -43,26 +43,6 @@
 #include "cxd56_audio_filter.h"
 #include "cxd56_audio_ac_reg.h"
 
-/***************************************************************************
- * Pre-processor Definitions
- ****************************************************************************/
-
-/***************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
-
-/***************************************************************************
- * Private Data
- ****************************************************************************/
-
-/***************************************************************************
- * Public Data
- ****************************************************************************/
-
-/***************************************************************************
- * Private Functions
- ****************************************************************************/
-
 /***************************************************************************
  * Public Functions
  ****************************************************************************/

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio_irq.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio_irq.c
@@ -43,28 +43,12 @@
 
 #include "cxd56_audio_irq.h"
 
-/***************************************************************************
- * Pre-processor Definitions
- ****************************************************************************/
-
 /***************************************************************************
  * Public Function Prototypes
  ****************************************************************************/
 
 extern void cxd56_audio_dma_int_handler(void);
 
-/***************************************************************************
- * Private Data
- ****************************************************************************/
-
-/***************************************************************************
- * Public Data
- ****************************************************************************/
-
-/***************************************************************************
- * Private Functions
- ****************************************************************************/
-
 /***************************************************************************
  * Public Functions
  ****************************************************************************/

diff --git a/boards/arm/cxd56xx/drivers/audio/cxd56_audio_mic.c b/boards/arm/cxd56xx/drivers/audio/cxd56_audio_mic.c
@@ -54,22 +54,6 @@
 #define MIC_CH_BITNUM  4
 #define MIC_CH_BITMAP  0xf
 
-/***************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
-
-/***************************************************************************
- * Private Data
- ****************************************************************************/
-
-/***************************************************************************
- * Public Data
- ****************************************************************************/
-
-/***************************************************************************
- * Private Functions
- ****************************************************************************/
-
 /***************************************************************************
  * Public Functions
  ****************************************************************************/