Changeset 116 in libcf

Timestamp:

06/05/13 15:09:37 (11 years ago)

Author:

cheese

Message:

#1 fix and arrange doxygen comments

Location:

trunk

Files:

• include/cf_base.h (modified) (1 diff)
• include/cf_codec.h (modified) (1 diff)
• include/cf_debug.h (modified) (1 diff)
• include/cf_error.h (modified) (1 diff)
• include/cf_file.h (modified) (1 diff)
• include/cf_list.h (modified) (1 diff)
• include/cf_log.h (modified) (1 diff)
• include/cf_queue.h (modified) (1 diff)
• include/cf_socket.h (modified) (1 diff)
• include/cf_stack.h (modified) (1 diff)
• include/cf_thread.h (modified) (1 diff)
• src/cf_codec.c (modified) (4 diffs)
• src/cf_list.c (modified) (1 diff)
• src/cf_log.c (modified) (2 diffs)
• src/cf_thread.c (modified) (1 diff)

trunk/include/cf_base.h

@@ -4 +4 @@
  * @version 0.1
  *
- * @remarks 기본 정의
+ * @brief 기본 정의
  *
  * @mainpage

trunk/include/cf_codec.h

@@ -3 +3 @@
  * @author  myusgun <myusgun@gmail.com>
  *
- * @remark 데이터 변환
+ * @brief 데이터 변환
  *
  * @example codec.c

trunk/include/cf_debug.h

@@ -3 +3 @@
  * @author  myusgun <myusgun@gmail.com>
  *
- * @remark
+ * @brief 디버그 유틸
+ *
+ * @remarks
  * 디버그 함수를 직접 호출하지 않고 정의된 매크로를 사용하면,
  * Preprocessor에 _DEBUG가 정의되어 있는 경우에 만

trunk/include/cf_error.h

@@ -3 +3 @@
  * @author  myusgun <myusgun@gmail.com>
  *
- * @remarks 오류코드 모음
+ * @brief 오류코드 모음
  */
 #ifndef __CF_ERROR_H__

trunk/include/cf_file.h

@@ -3 +3 @@
  * @author  myusgun <myusgun@gmail.com>
  *
- * @remarks 파일 I/O
+ * @brief 파일 입출력
  *
  * @example file.c

trunk/include/cf_list.h

@@ -2 +2 @@
  * @file    cf_list.h
  * @author  myusgun <myusgun@gmail.com>
+ *
+ * @brief 연결 리스트
+ *
+ * @example list.c
  */
 #ifndef __CF_LIST_H__

trunk/include/cf_log.h

@@ -3 +3 @@
  * @author  myusgun <myusgun@gmail.com>
  *
- * @remark
+ * @brief 로그
+ *
+ * @remarks
  * 매핑 ID 값을 이용하여 해당 로그에 기록 <br />
  * 로그 레벨을 적용할 때도 용이하며 define 이나 enumeration 등을 활용하면 좋음

trunk/include/cf_queue.h

@@ -3 +3 @@
  * @author  myusgun <myusgun@gmail.com>
  *
- * @remark 큐
+ * @brief 큐
  *
  * @example queue.c

trunk/include/cf_socket.h

@@ -3 +3 @@
  * @author  myusgun <myusgun@gmail.com>
  *
- * @remark TCP 소켓 지원
+ * @brief TCP 소켓 지원
  *
  * @example socket.c

trunk/include/cf_stack.h

@@ -3 +3 @@
  * @author  myusgun <myusgun@gmail.com>
  *
- * @remark 스택
+ * @brief 스택
  *
  * @example stack.c

trunk/include/cf_thread.h

@@ -3 +3 @@
  * @author  myusgun <myusgun@gmail.com>
  *
- * @remark 멀티스레드 및 뮤텍스 지원
+ * @brief 멀티스레드 및 뮤텍스 지원
  *
  * @example thread.c

trunk/src/cf_codec.c

@@ -76 +76 @@
  * @param hex   16진수 문자열을 저장할 주소
  *
- * @remark
+ * @remarks
  * hex는 할당된 메모리이며, 크기는 '\0'를 제외하고 len * 2
  */
@@ -116 +116 @@
  * @param len   바이너리 데이터의 길이를 저장할 주소
  *
- * @remark
+ * @remarks
  * bin는 할당된 메모리이며, 크기는 strlen (hex) / 2
  */
@@ -182 +182 @@
  * @param base64    base64 문자열을 저장할 주소
  *
- * @remark
+ * @remarks
  * base64는 할당된 메모리이며, 크기는 '\0'를 제외하고 ((len + 2) / 3) * 4
  */
@@ -245 +245 @@
  * @param len       바이너리 데이터의 길이를 저장할 주소
  *
- * @remark
+ * @remarks
  * base64는 할당된 메모리이며, 크기는 (strlen (base64)) / 4 * 3
  */

trunk/src/cf_list.c

@@ -135 +135 @@
  * @param element   삽입할 데이터 주소
  *
- * @remark
+ * @remarks
  * traverser가 NULL일 때,
  * direction이 CF_DIRECTION_BEFORE라면 Front 위치이고

trunk/src/cf_log.c

@@ -448 +448 @@
  * @param ctx   로그 컨텍스트
  *
- * @remark 반드시 먼저 초기화 해야하며, 초기화 시에 주어진 번호보다 작은 아이디 넘버를 사용
+ * @remarks 반드시 먼저 초기화 해야하며, 초기화 시에 주어진 번호보다 작은 아이디 넘버를 사용
  *
  * @see CF_LOG_OPEN, CF_Log_CreateCtx
@@ -472 +472 @@
  * @param mapid 로그의 아이디 넘버
  *
- * @remark 아이디 넘버에 해당하는 컨텍스트가 해제되므로 주의
+ * @remarks 아이디 넘버에 해당하는 컨텍스트가 해제되므로 주의
  *
  * @see CF_LOG_CLOSE, CF_Log_DestroyCtx

trunk/src/cf_thread.c

@@ -126 +126 @@
  * @param threadID 스레드 아이디 주소
  *
- * @remark 스레드 아이디를 해제하는 것이며 워커 스레드가 종료되지 않음
+ * @remarks 스레드 아이디를 해제하는 것이며 워커 스레드가 종료되지 않음
  */
 int