Changeset 35 in libcf for trunk/src/cf_debug.c

Timestamp:

02/05/13 18:18:37 (11 years ago)

Author:

cheese

Message:

#1 separate example code and doxygen comment and fix logging push logic by vfire

File:

• trunk/src/cf_debug.c (modified) (9 diffs)

trunk/src/cf_debug.c

@@ -115 +115 @@
 }
 
+/**
+ * 디버그 컨텍스트를 생성
+ *
+ * @return 성공 시, CF_Debug_Ctx 형태의 컨텍스트; 실패 시, NULL
+ * @see CF_DEBUG_CREATE_CTX
+ */
 CF_Debug_Ctx
 CF_Debug_CreateCtx (void)
@@ -125 +131 @@
 }
 
+/**
+ * 디버그 컨텍스트를 해제
+ *
+ * @return 성공 시, CF_OK; 실패 시, 오류 코드
+ *
+ * @param ctx 디버그 컨텍스트
+ *
+ * @see CF_DEBUG_DESTROY_CTX
+ */
 int
 CF_Debug_DestroyCtx (CF_Debug_Ctx ctx)
@@ -148 +163 @@
 }
 
+/**
+ * 디버그 컨텍스트에 출력할 파일 디스크립터를 설정
+ *
+ * @return 성공 시, CF_OK; 실패 시, 오류 코드
+ *
+ * @param ctx   디버그 컨텍스트
+ * @param fd    파일 디스크립터
+ *
+ * @see CF_File_Open, CF_File_Create
+ */
 int
 CF_Debug_SetOutputFD (CF_Debug_Ctx  ctx,
@@ -187 +212 @@
 }
 
+/**
+ * 디버그 메시지를 지정된 파일 포인터로 출력
+ *
+ * @return 성공 시, CF_OK; 실패 시, 오류 코드
+ *
+ * @param fp    파일 포인터. 표준출력(stdout) 및 표준오류(stderr) 사용 가능
+ * @param file  파일 경로
+ * @param func  함수 이름
+ * @param line  라인 넘버
+ * @param fmt   포맷 스트링
+ * @param ...   가변 인자
+ *
+ * @see CF_DEBUG_PRINT
+ */
 int
 CF_Debug_Print (FILE        * fp,
@@ -203 +242 @@
 }
 
+/**
+ * 바이너리 데이터를 디버그 메시지와 함께 지정된 파일 포인터로 출력
+ *
+ * @return CF_OK 반환
+ *
+ * @param fp    파일 포인터. 표준출력(stdout) 및 표준오류(stderr) 사용 가능
+ * @param file  파일 경로
+ * @param func  함수 이름
+ * @param line  라인 넘버
+ * @param bin   라인 넘버
+ * @param len   바이너리 길이
+ * @param fmt   포맷 스트링
+ * @param ...   가변 인자
+ *
+ * @see CF_DEBUG_PRINT_BIN
+ */
 int
 CF_Debug_PrintBin (FILE                 * fp,
@@ -223 +278 @@
 }
 
+/**
+ * 컨텍스트를 업데이트하고 디버그 메시지를 출력
+ *
+ * @return CF_OK 반환
+ *
+ * @param ctx   디버그 컨텍스트
+ * @param file  파일 경로
+ * @param func  함수 이름
+ * @param line  라인 넘버
+ * @param fmt   포맷 스트링
+ * @param ...   가변 인자
+ *
+ * @see CF_DEBUG_UPDATE_CTX, CF_Debug_Trace
+ */
 int
 CF_Debug_Trace (CF_Debug_Ctx    ctx,
@@ -248 +317 @@
 }
 
+/**
+ * 컨텍스트를 업데이트하고 바이너리 데이터를 디버그 메시지와 함께 출력
+ *
+ * @return 성공 시, CF_OK; 실패 시, 오류 코드
+ *
+ * @param ctx   디버그 컨텍스트
+ * @param file  파일 경로
+ * @param func  함수 이름
+ * @param line  라인 넘버
+ * @param bin   바이너리 데이터
+ * @param len   바이너리 길이
+ * @param fmt   포맷 스트링
+ * @param ...   가변 인자
+ *
+ * @see CF_DEBUG_UPDATE_CTX, CF_DEBUG_TRACE_BIN
+ */
 int
 CF_Debug_TraceBin (CF_Debug_Ctx         ctx,
@@ -281 +366 @@
 }
 
+/**
+ * 컨텍스트에 콜스택 푸시
+ *
+ * @return 성공 시, CF_OK; 실패 시, 오류 코드
+ *
+ * @param ctx   디버그 컨텍스트
+ * @param file  파일 경로
+ * @param func  함수 이름
+ * @param line  라인 넘버
+ *
+ * @see CF_DEBUG_CALLSTACK_PUSH
+ */
 int
 CF_Debug_CallStackPush (CF_Debug_Ctx    ctx,
@@ -308 +405 @@
 }
 
+/**
+ * 컨텍스트에서 콜스택 팝
+ *
+ * @return 성공 시, CF_OK; 실패 시, 오류 코드
+ *
+ * @param ctx       디버그 컨텍스트
+ * @param callstack 콜스택 정보를 가져올 콜스택 데이터 구조체 포인터
+ *
+ * @see CF_Debug_CallStackPop, CF_Debug_CallStack
+ */
 int
 CF_Debug_CallStackPop (CF_Debug_Ctx         ctx,