Skip to content

Commit 78b37fd

Browse files
committed
try to fix the Doxygen and style problem
1 parent c12ac69 commit 78b37fd

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

hal/include/hal/can_api.h

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,28 +90,36 @@ void can_init_direct(can_t *obj, const can_pinmap_t *pinmap);
9090
* @param obj CAN object
9191
* @param rd The CAN RD pin name
9292
* @param td The CAN TD pin name
93+
#ifdef DEVICE_CAN_FD
9394
* @param hz The bus frequency in classical CAN mode, or nominal phase frequency in CAN FD mode
9495
* @param data_hz The data phase frequency in CAN FD mode, the CAN object is put into Classical CAN mode if this parameter is zero
96+
#else
97+
* @param hz The bus frequency
98+
#endif
9599
*/
96100
void can_init_freq(can_t *obj, PinName rd, PinName td, int hz
97101
#ifdef DEVICE_CAN_FD
98-
, int data_hz
102+
, int data_hz
99103
#endif
100-
);
104+
);
101105

102106
/** Initialize the CAN peripheral. It sets the default parameters for CAN
103107
* peripheral, and configures its specifieds pins.
104108
*
105109
* @param obj CAN object
106110
* @param pinmap pointer to structure which holds static pinmap
111+
#ifdef DEVICE_CAN_FD
107112
* @param hz The bus frequency in classical CAN mode, or nominal phase frequency in CAN FD mode
108113
* @param data_hz The data phase frequency in CAN FD mode, the CAN object is put into Classical CAN mode if this parameter is zero
114+
#else
115+
* @param hz The bus frequency
116+
#endif
109117
*/
110118
void can_init_freq_direct(can_t *obj, const can_pinmap_t *pinmap, int hz
111119
#ifdef DEVICE_CAN_FD
112-
, int data_hz
120+
, int data_hz
113121
#endif
114-
);
122+
);
115123

116124
/** Release the CAN peripheral, not currently invoked. It requires further
117125
* resource management.
@@ -123,14 +131,18 @@ void can_free(can_t *obj);
123131
/** Configure the CAN bus frequency
124132
*
125133
* @param obj The CAN object
134+
#ifdef DEVICE_CAN_FD
126135
* @param hz The bus frequency in classical CAN mode, or nominal phase frequency in CAN FD mode
127136
* @param data_hz The data phase frequency in CAN FD mode, the CAN object is put into Classical CAN mode if this parameter is zero
137+
#else
138+
* @param hz The bus frequency
139+
#endif
128140
*/
129141
int can_frequency(can_t *obj, int hz
130142
#ifdef DEVICE_CAN_FD
131-
, int data_hz
143+
, int data_hz
132144
#endif
133-
);
145+
);
134146

135147
/** Initialize the CAN IRQ handler
136148
*

0 commit comments

Comments
 (0)