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


Ignore:
Timestamp:
06/10/13 09:56:32 (11 years ago)
Author:
cheese
Message:

#1 fix and arrange doxygen configuration file and doxygen comments

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/cf_debug.c

    r117 r119  
    11/**
    2  * @file    cf_debug.c
    3  * @author  myusgun <myusgun@gmail.com>
    4  *
    5  * @brief 디버그 유틸 구현
     2 * \file    cf_debug.c
     3 * \author  myusgun <myusgun@gmail.com>
     4 *
     5 * \brief 디버그 유틸 구현
    66 */
    77#include "cf_debug.h"
     
    112112 * 디버그 메시지를 지정된 파일 포인터로 출력
    113113 *
    114  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    115  *
    116  * @param fp    파일 포인터. 표준출력(stdout) 및 표준오류(stderr) 사용 가능
    117  * @param file  파일 경로
    118  * @param func  함수 이름
    119  * @param line  라인 넘버
    120  * @param fmt   포맷 스트링
    121  * @param ...   가변 인자
    122  *
    123  * @see CF_DEBUG_PRINT
     114 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     115 *
     116 * \param fp    파일 포인터. 표준출력(stdout) 및 표준오류(stderr) 사용 가능
     117 * \param file  파일 경로
     118 * \param func  함수 이름
     119 * \param line  라인 넘버
     120 * \param fmt   포맷 스트링
     121 * \param ...   가변 인자
     122 *
     123 * \see CF_DEBUG_PRINT
    124124 */
    125125int
     
    142142 * 바이너리 데이터를 디버그 메시지와 함께 지정된 파일 포인터로 출력
    143143 *
    144  * @return CF_OK 반환
    145  *
    146  * @param fp    파일 포인터. 표준출력(stdout) 및 표준오류(stderr) 사용 가능
    147  * @param file  파일 경로
    148  * @param func  함수 이름
    149  * @param line  라인 넘버
    150  * @param bin   라인 넘버
    151  * @param len   바이너리 길이
    152  * @param fmt   포맷 스트링
    153  * @param ...   가변 인자
    154  *
    155  * @see CF_DEBUG_PRINT_BIN
     144 * \return CF_OK 반환
     145 *
     146 * \param fp    파일 포인터. 표준출력(stdout) 및 표준오류(stderr) 사용 가능
     147 * \param file  파일 경로
     148 * \param func  함수 이름
     149 * \param line  라인 넘버
     150 * \param bin   라인 넘버
     151 * \param len   바이너리 길이
     152 * \param fmt   포맷 스트링
     153 * \param ...   가변 인자
     154 *
     155 * \see CF_DEBUG_PRINT_BIN
    156156 */
    157157int
     
    178178 * 컨텍스트에 콜스택 푸시
    179179 *
    180  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    181  *
    182  * @param ctx   디버그 컨텍스트
    183  * @param file  파일 경로
    184  * @param func  함수 이름
    185  * @param line  라인 넘버
     180 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     181 *
     182 * \param ctx   디버그 컨텍스트
     183 * \param file  파일 경로
     184 * \param func  함수 이름
     185 * \param line  라인 넘버
    186186 */
    187187static int
     
    214214 * 컨텍스트에서 콜스택에서 TOP을 제거하지 않고 가져옴
    215215 *
    216  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    217  *
    218  * @param ctx       디버그 컨텍스트
    219  * @param callstack 콜스택 정보를 가져올 콜스택 데이터 구조체 포인터
    220  *
    221  * @see CF_Debug_CallStack
     216 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     217 *
     218 * \param ctx       디버그 컨텍스트
     219 * \param callstack 콜스택 정보를 가져올 콜스택 데이터 구조체 포인터
     220 *
     221 * \see CF_Debug_CallStack
    222222 */
    223223static int
     
    245245 * 컨텍스트에서 콜스택 팝
    246246 *
    247  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    248  *
    249  * @param ctx       디버그 컨텍스트
    250  * @param callstack 콜스택 정보를 가져올 콜스택 데이터 구조체 포인터
    251  *
    252  * @see CF_Debug_CallStack
     247 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     248 *
     249 * \param ctx       디버그 컨텍스트
     250 * \param callstack 콜스택 정보를 가져올 콜스택 데이터 구조체 포인터
     251 *
     252 * \see CF_Debug_CallStack
    253253 */
    254254static int
     
    277277 * 디버그 컨텍스트를 해제
    278278 *
    279  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    280  *
    281  * @param ctx 디버그 컨텍스트
    282  *
    283  * @see CF_DEBUG_DESTROY_CTX
     279 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     280 *
     281 * \param ctx 디버그 컨텍스트
     282 *
     283 * \see CF_DEBUG_DESTROY_CTX
    284284 */
    285285static int
     
    304304 * 디버그 컨텍스트를 생성
    305305 *
    306  * @return 성공 시, CF_Debug_Ctx 형태의 컨텍스트; 실패 시, NULL
    307  * @see CF_DEBUG_CREATE_CTX
     306 * \return 성공 시, CF_Debug_Ctx 형태의 컨텍스트; 실패 시, NULL
     307 * \see CF_DEBUG_CREATE_CTX
    308308 */
    309309static int
     
    341341 * 콜스택 매니저 초기화 (글로벌 컨텍스트)
    342342 *
    343  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    344  *
    345  * @see CF_Debug_Finalize
     343 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     344 *
     345 * \see CF_Debug_Finalize
    346346 */
    347347int
     
    359359 * 콜스택 매니저 해제 (글로벌 컨텍스트)
    360360 *
    361  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     361 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    362362 */
    363363int
     
    374374 * 함수 진입을 명시 (글로벌 컨텍스트)
    375375 *
    376  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    377  *
    378  * @param file  파일 경로
    379  * @param func  함수 이름
    380  * @param line  라인 넘버
    381  *
    382  * @see CF_Debug_LeaveFunction
     376 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     377 *
     378 * \param file  파일 경로
     379 * \param func  함수 이름
     380 * \param line  라인 넘버
     381 *
     382 * \see CF_Debug_LeaveFunction
    383383 */
    384384int
     
    401401 * 함수 종료를 명시 (글로벌 컨텍스트)
    402402 *
    403  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    404  *
    405  * @see CF_Debug_EnterFunction
     403 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     404 *
     405 * \see CF_Debug_EnterFunction
    406406 */
    407407int
     
    422422 * 현재 콜스택을 출력 (글로벌 컨텍스트)
    423423 *
    424  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    425  *
    426  * @param fp 출력 할 파일 포인터
     424 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     425 *
     426 * \param fp 출력 할 파일 포인터
    427427 */
    428428int
Note: See TracChangeset for help on using the changeset viewer.