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

    r117 r119  
    11/**
    2  * @file    cf_list.c
    3  * @author  myusgun <myusgun@gmail.com>
    4  *
    5  * @brief 연결 리스트 구현
     2 * \file    cf_list.c
     3 * \author  myusgun <myusgun@gmail.com>
     4 *
     5 * \brief 연결 리스트 구현
    66 */
    77#include "cf_list.h"
     
    4242 * 리스트 컨텍스트 생성
    4343 *
    44  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    45  *
    46  * @param ctx 리스트 컨텍스트 포인터
     44 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     45 *
     46 * \param ctx 리스트 컨텍스트 포인터
    4747 */
    4848int
     
    6565 * 리스트 컨텍스트 해제
    6666 *
    67  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    68  *
    69  * @param ctx 리스트 컨텍스트
     67 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     68 *
     69 * \param ctx 리스트 컨텍스트
    7070 */
    7171int
     
    8686 * 리스트 탐색자(Traverser)를 Front 위치로 설정
    8787 *
    88  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    89  *
    90  * @param ctx       리스트 컨텍스트
    91  * @param traverser 리스트 탐색자 주소
     88 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     89 *
     90 * \param ctx       리스트 컨텍스트
     91 * \param traverser 리스트 탐색자 주소
    9292 */
    9393int
     
    108108 * 리스트 탐색자(Traverser)를 Rear 위치로 설정
    109109 *
    110  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    111  *
    112  * @param ctx       리스트 컨텍스트
    113  * @param traverser 리스트 탐색자 주소
     110 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     111 *
     112 * \param ctx       리스트 컨텍스트
     113 * \param traverser 리스트 탐색자 주소
    114114 */
    115115int
     
    130130 * 리스트에 새 데이터 삽입
    131131 *
    132  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    133  *
    134  * @param ctx       리스트 컨텍스트
    135  * @param traverser 리스트 탐색자
    136  * @param direction 탐색자의 전/후를 지정
    137  * @param element   삽입할 데이터 주소
    138  *
    139  * @remarks
     132 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     133 *
     134 * \param ctx       리스트 컨텍스트
     135 * \param traverser 리스트 탐색자
     136 * \param direction 탐색자의 전/후를 지정
     137 * \param element   삽입할 데이터 주소
     138 *
     139 * \remarks
    140140 * traverser가 NULL일 때,
    141141 * direction이 CF_DIRECTION_BEFORE라면 Front 위치이고
     
    210210 * 리스트에서 탐색자 위치의 항목을 삭제
    211211 *
    212  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    213  *
    214  * @param ctx       리스트 컨텍스트
    215  * @param traverser 리스트 탐색자 주소
     212 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     213 *
     214 * \param ctx       리스트 컨텍스트
     215 * \param traverser 리스트 탐색자 주소
    216216 */
    217217int
     
    257257 * 리스트에서 모든 항목을 삭제
    258258 *
    259  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    260  *
    261  * @param ctx 리스트 컨텍스트
     259 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     260 *
     261 * \param ctx 리스트 컨텍스트
    262262 */
    263263int
     
    280280 * 탐색자 위치의 데이터를 가져옴
    281281 *
    282  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    283  *
    284  * @param traverser 리스트 탐색자
    285  * @param element   데이터 주소
     282 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     283 *
     284 * \param traverser 리스트 탐색자
     285 * \param element   데이터 주소
    286286 */
    287287int
     
    302302 * 탐색자 위치를 이전으로 이동
    303303 *
    304  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    305  *
    306  * @param traverser 리스트 탐색자 주소
     304 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     305 *
     306 * \param traverser 리스트 탐색자 주소
    307307 */
    308308int
     
    325325 * 탐색자 위치를 다음으로 이동
    326326 *
    327  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    328  *
    329  * @param traverser 리스트 탐색자 주소
     327 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     328 *
     329 * \param traverser 리스트 탐색자 주소
    330330 */
    331331int
     
    348348 * 리스트에 등록된 항목의 수를 가져옴
    349349 *
    350  * @return 성공 시, 항목 수; 실패 시, 오류 코드
    351  *
    352  * @param ctx 리스트 컨텍스트
     350 * \return 성공 시, 항목 수; 실패 시, 오류 코드
     351 *
     352 * \param ctx 리스트 컨텍스트
    353353 */
    354354int
Note: See TracChangeset for help on using the changeset viewer.