Changeset 111 in libcf


Ignore:
Timestamp:
06/04/13 14:36:02 (11 years ago)
Author:
cheese
Message:

#1 add doxygen comments

Location:
trunk/src
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/cf_queue.c

    r109 r111  
    99#include <stdio.h>
    1010
     11/**
     12 * 큐 컨텍스트 생성
     13 *
     14 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     15 *
     16 * @param ctx 큐 컨텍스트 포인터
     17 */
    1118int
    1219CF_Queue_CreateCtx (CF_Queue_Ctx * ctx)
    … …  
    1522}
    1623
     24/**
     25 * 큐 컨텍스트 해제
     26 *
     27 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     28 *
     29 * @param ctx 큐 컨텍스트
     30 */
    1731int
    1832CF_Queue_DestroyCtx (CF_Queue_Ctx ctx)
    … …  
    2135}
    2236
     37/**
     38 * 큐에 삽입
     39 *
     40 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     41 *
     42 * @param ctx       큐 컨텍스트
     43 * @param element   데이터 주소
     44 */
    2345int
    2446CF_Queue_Put (CF_Queue_Ctx  ctx,
    … …  
    3658}
    3759
     60/**
     61 * 큐에서 꺼내기
     62 *
     63 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     64 *
     65 * @param ctx       큐 컨텍스트
     66 * @param element   데이터 주소
     67 */
    3868int
    3969CF_Queue_Get (CF_Queue_Ctx  ctx,
    … …  
    5585}
    5686
     87/**
     88 * 큐 처음의 데이터 조회
     89 *
     90 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     91 *
     92 * @param ctx       큐 컨텍스트
     93 * @param element   데이터 주소
     94 */
    5795int
    5896CF_Queue_Front (CF_Queue_Ctx    ctx,
    … …  
    70108}
    71109
     110/**
     111 * 큐에 등록된 항목의 수를 가져옴
     112 *
     113 * @return 성공 시, 항목 수; 실패 시, 오류 코드
     114 *
     115 * @param ctx 큐 컨텍스트
     116 */
    72117int
    73118CF_Queue_GetSize (CF_Queue_Ctx ctx)

  • trunk/src/cf_stack.c

    r109 r111  
    99#include <stdio.h>
    1010
     11/**
     12 * 스택 컨텍스트 생성
     13 *
     14 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     15 *
     16 * @param ctx 스택 컨텍스트 포인터
     17 */
    1118int
    1219CF_Stack_CreateCtx (CF_Stack_Ctx * ctx)
    … …  
    1522}
    1623
     24/**
     25 * 스택 컨텍스트 해제
     26 *
     27 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     28 *
     29 * @param ctx 스택 컨텍스트
     30 */
    1731int
    1832CF_Stack_DestroyCtx (CF_Stack_Ctx ctx)
    … …  
    2135}
    2236
     37/**
     38 * 스택에 삽입
     39 *
     40 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     41 *
     42 * @param ctx       스택 컨텍스트
     43 * @param element   데이터 주소
     44 */
    2345int
    2446CF_Stack_Push (CF_Stack_Ctx ctx,
    … …  
    3658}
    3759
     60/**
     61 * 스택에서 꺼내기
     62 *
     63 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     64 *
     65 * @param ctx       스택 컨텍스트
     66 * @param element   데이터 주소
     67 */
    3868int
    3969CF_Stack_Pop (CF_Stack_Ctx  ctx,
    … …  
    5585}
    5686
     87/**
     88 * 스택 최상위의 데이터 조회
     89 *
     90 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     91 *
     92 * @param ctx       스택 컨텍스트
     93 * @param element   데이터 주소
     94 */
    5795int
    5896CF_Stack_Top (CF_Stack_Ctx  ctx,
    … …  
    70108}
    71109
     110/**
     111 * 스택에 등록된 항목의 수를 가져옴
     112 *
     113 * @return 성공 시, 항목 수; 실패 시, 오류 코드
     114 *
     115 * @param ctx 스택 컨텍스트
     116 */
    72117int
    73118CF_Stack_GetSize (CF_Stack_Ctx ctx)
Note: See TracChangeset for help on using the changeset viewer.