Skip to content

Commit 873ce6d

Browse files
committed
change comment style
1 parent e89d93d commit 873ce6d

File tree

1 file changed

+36
-36
lines changed

1 file changed

+36
-36
lines changed

DataSampling.c

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ static tS32 Ret;
2222

2323
/*********************************************************************************/
2424
/*
25-
1) 인수
25+
@brief
26+
- 버퍼에 데이터 삽입.
27+
28+
@param
2629
- Smp : tag_DataSampling 인스턴스의 주소.
2730
- Idx : 데이터 삽입 위치를 지시하는 index.
2831
- Data : 삽입할 데이터.
2932
30-
2) 반환
33+
@retval
3134
- 없음.
32-
33-
3) 설명
34-
- 버퍼에 데이터 삽입.
3535
*/
3636
inline static void InToBuf(tag_DataSampling *Smp, tU8 Idx, tS32 Data)
3737
{
@@ -44,15 +44,15 @@ inline static void InToBuf(tag_DataSampling *Smp, tU8 Idx, tS32 Data)
4444
}
4545
/*********************************************************************************/
4646
/*
47-
1) 인수
47+
@brief
48+
- 버퍼에서 특정 index의 데이터를 반환한다.
49+
50+
@param
4851
- Smp : tag_DataSampling 인스턴스의 주소.
4952
- Idx : 데이터 삽입 위치를 지시하는 index.
5053
51-
2) 반환
54+
@retval
5255
- 읽은 데이터.
53-
54-
3) 설명
55-
- 버퍼에서 특정 index의 데이터를 반환한다.
5656
*/
5757
inline static tS32 OutFromBuf(tag_DataSampling *Smp, tU8 Idx)
5858
{
@@ -67,15 +67,15 @@ inline static tS32 OutFromBuf(tag_DataSampling *Smp, tU8 Idx)
6767
}
6868
/*********************************************************************************/
6969
/*
70-
1) 인수
70+
@brief
71+
- 인수로 전달받은 데이터로 버퍼를 채움.
72+
73+
@param
7174
- Smp : tag_DataSampling 인스턴스의 주소.
7275
- Data : 버퍼를 채울 데이터.
7376
74-
2) 반환
77+
@retval
7578
- 없음.
76-
77-
3) 설명
78-
- 인수로 전달받은 데이터로 버퍼를 채움.
7979
*/
8080
static void FillBuffer(tag_DataSampling *Smp, tS32 Data)
8181
{
@@ -90,17 +90,17 @@ static void FillBuffer(tag_DataSampling *Smp, tS32 Data)
9090
}
9191
/*********************************************************************************/
9292
/*
93-
1) 인수
93+
@brief
94+
- 'tag_DataSampling' 인스턴스의 필수 초기화 실행.
95+
- DataSampling 모듈을 사용하기 위해 선행적 실행 필요.
96+
97+
@param
9498
- Smp : tag_DataSampling 인스턴스의 주소.
9599
- BufSize : 동적할당 받을 버퍼의 크기.
96100
97-
2) 반환
101+
@retval
98102
- 0 : 초기화 실패.
99103
- 1 : 초기화 성공.
100-
101-
3) 설명
102-
- 'tag_DataSampling' 인스턴스의 필수 초기화 실행.
103-
- DataSampling 모듈을 사용하기 위해 선행적 실행 필요.
104104
*/
105105
tU8 DataSamplingInitGeneral(tag_DataSampling *Smp, tS16 BufSize, tS8 DataSize)
106106
{
@@ -129,15 +129,15 @@ tU8 DataSamplingInitGeneral(tag_DataSampling *Smp, tS16 BufSize, tS8 DataSize)
129129
}
130130
/*********************************************************************************/
131131
/*
132-
1) 인수
132+
@brief
133+
- 샘플링 수준(Level) 변경.
134+
135+
@param
133136
- Smp : tag_DataSampling 인스턴스의 주소.
134137
- Level : 변경할 샘플링 수준.
135138
136-
2) 반환
139+
@retval
137140
- 없음.
138-
139-
3) 설명
140-
- 샘플링 수준(Level) 변경.
141141
*/
142142
void DataSamplingChangeLevel(tag_DataSampling *Smp, tS16 Level)
143143
{
@@ -154,15 +154,15 @@ void DataSamplingChangeLevel(tag_DataSampling *Smp, tS16 Level)
154154
}
155155
/*********************************************************************************/
156156
/*
157-
1) 인수
157+
@brief
158+
- ring buffer 형식으로 데이터를 입력 받아 평균을 내어 샘플링.
159+
160+
@param
158161
- Smp : tag_DataSampling 인스턴스의 주소.
159162
- Data : 데이터.
160163
161-
2) 반환
164+
@retval
162165
- Result : 샘플링된 데이터.
163-
164-
3) 설명
165-
- ring buffer 형식으로 데이터를 입력 받아 평균을 내어 샘플링.
166166
*/
167167
tS32 DataSamplingGetData(tag_DataSampling *Smp, tS32 Data)
168168
{
@@ -190,14 +190,14 @@ tS32 DataSamplingGetData(tag_DataSampling *Smp, tS32 Data)
190190
}
191191
/*********************************************************************************/
192192
/*
193-
1) 인수
193+
@brief
194+
- 버퍼 초기화 실행.
195+
196+
@param
194197
- Smp : tag_DataSampling 인스턴스의 주소.
195198
196-
2) 반환
199+
@retval
197200
- 없음.
198-
199-
3) 설명
200-
- 버퍼 초기화 실행.
201201
*/
202202
void DataSamplingResetData(tag_DataSampling *Smp)
203203
{

0 commit comments

Comments
 (0)