Changeset 34 in libcf for trunk/include/cf_debug.h

Timestamp:

02/05/13 11:26:59 (11 years ago)

Author:

cheese

Message:

#1 add example code for doxygen

File:

• trunk/include/cf_debug.h (modified) (2 diffs)

trunk/include/cf_debug.h

@@ -11 +11 @@
  * 환경에 적합하도록 사용자가 구성한 컨텍스트를 이용하여 사용할 수도 있음 <br />
  * (단, 콜스택의 푸시/팝은 컨텍스트를 이용해야만 사용 가능)
+ *
+ * @section 샘플코드
+ * @code
+
+#include "cf_debug.h"
+
+CF_Debug_Ctx gDebugCtx;
+
+void callee (void) {
+    CF_Debug_CallStack callstack;
+    
+    CF_DEBUG_CALLSTACK_PUSH (gDebugCtx);
+    CF_DEBUG_CALLSTACK_POP (gDebugCtx, &callstack);
+}
+
+int main (void) {
+    int fd = 0;
+    gDebugCtx = CF_Debug_CreateCtx ();
+
+    CF_DEBUG_CALLSTACK_PUSH (gDebugCtx);
+
+    CF_DEBUG_TRACE (gDebugCtx, "print trace message with context to stderr\n");
+
+    fd = CF_File_Create ("debug.txt");
+    if (fd < 0) {
+        CF_DEBUG_PRINT (stderr, "error ...\n");
+        // error
+    }
+    CF_Debug_SetOutputFD (gDebugCtx, fd);
+
+    CF_DEBUG_TRACE (gDebugCtx, "print trace message with context to debug.txt\n");
+
+    CF_DEBUG_CALLSTACK_POP (gDebugCtx, NULL);
+
+    CF_Debug_DestroyCtx (gDebugCtx);
+
+    return 0;
+}
+
+ * @endcode
  */
 #ifndef __CF_DEBUG_H__
@@ -19 +59 @@
 #include <stdio.h>
 
-/** 잘못된 컨텍스트 오류 */
 #define CF_ERROR_DEBUG_INVALID_CTX          CF_ERROR_DEBUG - 1
-
-/** 디버그 메시지 출력을 위한 파일 포인터 설정 오류 */
 #define CF_ERROR_DEBUG_SET_OUTPUT_FD        CF_ERROR_DEBUG - 2
-
-/** 콜스택 푸시 오류 */
 #define CF_ERROR_DEBUG_PUSH_CALLSTACK       CF_ERROR_DEBUG - 3
-
-/** 콜스택 팝 오류 */
 #define CF_ERROR_DEBUG_POP_CALLSTACK        CF_ERROR_DEBUG - 4