Changeset 119 in libcf for trunk/src/cf_log.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_log.c

    r117 r119  
    11/**
    2  * @file    cf_log.c
    3  * @author  myusgun <myusgun@gmail.com>
    4  * @author  vfire
    5  *
    6  * @brief 로그 구현
     2 * \file    cf_log.c
     3 * \author  myusgun <myusgun@gmail.com>
     4 * \author  vfire
     5 *
     6 * \brief 로그 구현
    77 */
    88#if defined(_WIN32) || defined(_WIN64)
    … …  
    195195 * 로그 데이터 처리
    196196 *
    197  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    198  *
    199  * @param ctx           로그 컨텍스트
    200  * @param buffer        로그 데이터
    201  * @param demandSize    로그 데이터 길이
    202  *
    203  * @author vfire
     197 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     198 *
     199 * \param ctx           로그 컨텍스트
     200 * \param buffer        로그 데이터
     201 * \param demandSize    로그 데이터 길이
     202 *
     203 * \author vfire
    204204 */
    205205/* static */int
    … …  
    243243 * 로그 컨텍스트에 멀티쓰레드 모드 설정
    244244 *
    245  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    246  *
    247  * @param ctx 로그 컨텍스트
    248  *
    249  * @see CF_Log_UnsetMultiThread
     245 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     246 *
     247 * \param ctx 로그 컨텍스트
     248 *
     249 * \see CF_Log_UnsetMultiThread
    250250 */
    251251static int
    … …  
    265265 * 로그 컨텍스트에 멀티쓰레드 모드 설정 해제
    266266 *
    267  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    268  *
    269  * @param ctx 로그 컨텍스트
    270  *
    271  * @see CF_Log_SetMultiThread
     267 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     268 *
     269 * \param ctx 로그 컨텍스트
     270 *
     271 * \see CF_Log_SetMultiThread
    272272 */
    273273static int
    … …  
    287287 * 로그 컨텍스트에 따라 로그 쓰기
    288288 *
    289  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    290  *
    291  * @param ctx       로그 컨텍스트
    292  * @param prefix    로그의 프리픽스 문자열
    293  * @param fmt       포맷 스트링
    294  * @param ...       가변 인자
     289 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     290 *
     291 * \param ctx       로그 컨텍스트
     292 * \param prefix    로그의 프리픽스 문자열
     293 * \param fmt       포맷 스트링
     294 * \param ...       가변 인자
    295295 */
    296296static int
    … …  
    328328 * 로그 버퍼의 데이터를 즉시 로그 파일에 쓰기
    329329 *
    330  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    331  *
    332  * @param ctx 로그 컨텍스트
     330 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     331 *
     332 * \param ctx 로그 컨텍스트
    333333 */
    334334static int
    … …  
    349349 * 로그 컨텍스트 해제
    350350 *
    351  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    352  *
    353  * @param ctx 로그 컨텍스트
     351 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     352 *
     353 * \param ctx 로그 컨텍스트
    354354 */
    355355static int
    … …  
    379379 * 로그 컨텍스트 생성
    380380 *
    381  * @return 성공 시, 로그 컨텍스트; 실패 시, NULL
    382  *
    383  * @param path      로그 파일 경로
    384  * @param memsize   로그 버퍼 크기
    385  * @param ctx       로그 컨텍스트 받을 주소
    386  *
    387  * @see CF_LOG_DEFAULT_BUFFER, CF_LOG_NO_BUFFER
     381 * \return 성공 시, 로그 컨텍스트; 실패 시, NULL
     382 *
     383 * \param path      로그 파일 경로
     384 * \param memsize   로그 버퍼 크기
     385 * \param ctx       로그 컨텍스트 받을 주소
     386 *
     387 * \see CF_LOG_DEFAULT_BUFFER, CF_LOG_NO_BUFFER
    388388 */
    389389static int
    … …  
    445445 * 로그 기록 시, 아이디 넘버를 사용하면 해당 로그로 기록할 수 있음
    446446 *
    447  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    448  *
    449  * @param mapid 부여할 아이디 넘버
    450  * @param ctx   로그 컨텍스트
    451  *
    452  * @remarks 반드시 먼저 초기화 해야하며, 초기화 시에 주어진 번호보다 작은 아이디 넘버를 사용
    453  *
    454  * @see CF_LOG_OPEN, CF_Log_CreateCtx
     447 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     448 *
     449 * \param mapid 부여할 아이디 넘버
     450 * \param ctx   로그 컨텍스트
     451 *
     452 * \remarks 반드시 먼저 초기화 해야하며, 초기화 시에 주어진 번호보다 작은 아이디 넘버를 사용
     453 *
     454 * \see CF_LOG_OPEN, CF_Log_CreateCtx
    455455 */
    456456static int
    … …  
    470470 * 아이디 넘버에 해당하는 로그를 닫고 해당하는 컨텍스트를 해제
    471471 *
    472  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    473  *
    474  * @param mapid 로그의 아이디 넘버
    475  *
    476  * @remarks 아이디 넘버에 해당하는 컨텍스트가 해제되므로 주의
    477  *
    478  * @see CF_LOG_CLOSE, CF_Log_DestroyCtx
     472 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     473 *
     474 * \param mapid 로그의 아이디 넘버
     475 *
     476 * \remarks 아이디 넘버에 해당하는 컨텍스트가 해제되므로 주의
     477 *
     478 * \see CF_LOG_CLOSE, CF_Log_DestroyCtx
    479479 */
    480480static int
    … …  
    496496 * 아이디 넘버에 해당하는 로그 컨텍스트를 얻기
    497497 *
    498  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    499  *
    500  * @param mapid 로그의 아이디 넘버
    501  * @param ctx   로그 컨텍스트 받을 주소
     498 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     499 *
     500 * \param mapid 로그의 아이디 넘버
     501 * \param ctx   로그 컨텍스트 받을 주소
    502502 */
    503503static int
    … …  
    517517 * 로그를 사용하기 위해 초기화
    518518 *
    519  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    520  *
    521  * @param poolSize  로그 풀 크기로, 로그 아이디 넘버의 최대 값
     519 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     520 *
     521 * \param poolSize  로그 풀 크기로, 로그 아이디 넘버의 최대 값
    522522 */
    523523int
    … …  
    541541 * 로그가 모두 사용된 후 자원 해제
    542542 *
    543  * @return CF_OK 반환
     543 * \return CF_OK 반환
    544544 */
    545545int
    … …  
    564564 * 로그 열기
    565565 *
    566  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    567  *
    568  * @param mapid     로그의 아이디 넘버
    569  * @param path      로그 파일 경로
    570  * @param memsize   로그 버퍼 크기
    571  *
    572  * @see CF_LOG_DEFAULT_BUFFER, CF_LOG_NO_BUFFER
     566 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     567 *
     568 * \param mapid     로그의 아이디 넘버
     569 * \param path      로그 파일 경로
     570 * \param memsize   로그 버퍼 크기
     571 *
     572 * \see CF_LOG_DEFAULT_BUFFER, CF_LOG_NO_BUFFER
    573573 */
    574574int
    … …  
    594594 * 로그 닫기
    595595 *
    596  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    597  *
    598  * @param mapid 로그의 아이디 넘버
     596 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     597 *
     598 * \param mapid 로그의 아이디 넘버
    599599 */
    600600int
    … …  
    607607 * 로그 버퍼의 데이터를 즉시 로그 파일에 쓰기
    608608 *
    609  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    610  *
    611  * @param mapid 로그의 아이디 넘버
     609 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     610 *
     611 * \param mapid 로그의 아이디 넘버
    612612 */
    613613int
    … …  
    629629 * 로그 컨텍스트에 멀티쓰레드 모드 설정
    630630 *
    631  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    632  *
    633  * @param mapid 로그의 아이디 넘버
    634  * @param flag  설정/해제 bool 플래그
    635  *
    636  * @see CF_BOOL
     631 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     632 *
     633 * \param mapid 로그의 아이디 넘버
     634 * \param flag  설정/해제 bool 플래그
     635 *
     636 * \see CF_BOOL
    637637 */
    638638int
    … …  
    656656 * 로그 쓰기
    657657 *
    658  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    659  *
    660  * @param mapid     로그의 아이디 넘버
    661  * @param prefix    로그의 프리픽스 문자열
    662  * @param fmt       포맷 스트링
    663  * @param ...       가변 인자
     658 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     659 *
     660 * \param mapid     로그의 아이디 넘버
     661 * \param prefix    로그의 프리픽스 문자열
     662 * \param fmt       포맷 스트링
     663 * \param ...       가변 인자
    664664 */
    665665int
Note: See TracChangeset for help on using the changeset viewer.