Changeset 119 in libcf


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

#1 fix and arrange doxygen configuration file and doxygen comments

Location:
trunk
Files:
25 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/doxyfile

    r35 r119  
    213213# itcl::class meaning.
    214214
    215 TCL_SUBST              =
     215#TCL_SUBST              =
    216216
    217217# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
     
    261261# Disable only in case of backward compatibilities issues.
    262262
    263 MARKDOWN_SUPPORT       = YES
     263#MARKDOWN_SUPPORT       = YES
    264264
    265265# When enabled doxygen tries to link words that correspond to documented classes,
     
    268268# globally by setting AUTOLINK_SUPPORT to NO.
    269269
    270 AUTOLINK_SUPPORT       = YES
     270#AUTOLINK_SUPPORT       = YES
    271271
    272272# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
     
    319319# section (for LaTeX and RTF).
    320320
    321 INLINE_GROUPED_CLASSES = NO
     321#INLINE_GROUPED_CLASSES = NO
    322322
    323323# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
     
    328328# pages) or section (for LaTeX and RTF).
    329329
    330 INLINE_SIMPLE_STRUCTS  = NO
     330#INLINE_SIMPLE_STRUCTS  = NO
    331331
    332332# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
     
    365365# corresponding to a cache size of 2^16 = 65536 symbols.
    366366
    367 LOOKUP_CACHE_SIZE      = 0
     367#LOOKUP_CACHE_SIZE      = 0
    368368
    369369#---------------------------------------------------------------------------
     
    386386# scope will be included in the documentation.
    387387
    388 EXTRACT_PACKAGE        = NO
     388#EXTRACT_PACKAGE        = NO
    389389
    390390# If the EXTRACT_STATIC tag is set to YES all static members of a file
     
    616616# file names with spaces, bibtex cannot handle them.
    617617
    618 CITE_BIB_FILES         =
     618#CITE_BIB_FILES         =
    619619
    620620#---------------------------------------------------------------------------
     
    625625# by doxygen. Possible values are YES and NO. If left blank NO is used.
    626626
    627 QUIET                  = NO
     627QUIET                  = YES
    628628
    629629# The WARNINGS tag can be used to turn on/off the warning messages that are
     
    667667# to stderr.
    668668
    669 WARN_LOGFILE           =
     669WARN_LOGFILE           = warning.log
    670670
    671671#---------------------------------------------------------------------------
     
    800800# the introduction page also for the doxygen output.
    801801
    802 USE_MDFILE_AS_MAINPAGE =
     802#USE_MDFILE_AS_MAINPAGE =
    803803
    804804#---------------------------------------------------------------------------
     
    937937# the output directory.
    938938
    939 HTML_EXTRA_STYLESHEET  =
     939#HTML_EXTRA_STYLESHEET  =
    940940
    941941# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
     
    946946# the files will be copied as-is; there are no commands or markers available.
    947947
    948 HTML_EXTRA_FILES       =
     948#HTML_EXTRA_FILES       =
    949949
    950950# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
     
    994994# and will result in a full expanded tree by default.
    995995
    996 HTML_INDEX_NUM_ENTRIES = 100
     996#HTML_INDEX_NUM_ENTRIES = 100
    997997
    998998# If the GENERATE_DOCSET tag is set to YES, additional index files
     
    12151215# compatibility.
    12161216
    1217 MATHJAX_FORMAT         = HTML-CSS
     1217#MATHJAX_FORMAT         = HTML-CSS
    12181218
    12191219# When MathJax is enabled you need to specify the location relative to the
     
    12311231# names that should be enabled during MathJax rendering.
    12321232
    1233 MATHJAX_EXTENSIONS     =
     1233#MATHJAX_EXTENSIONS     =
    12341234
    12351235# When the SEARCHENGINE tag is enabled doxygen will generate a search box
     
    12611261# library Xapian. See the manual for configuration details.
    12621262
    1263 EXTERNAL_SEARCH        = NO
     1263#EXTERNAL_SEARCH        = NO
    12641264
    12651265# The SEARCHENGINE_URL should point to a search engine hosted by a web server
     
    12691269# details.
    12701270
    1271 SEARCHENGINE_URL       =
     1271#SEARCHENGINE_URL       =
    12721272
    12731273# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
     
    12751275# SEARCHDATA_FILE tag the name of this file can be specified.
    12761276
    1277 SEARCHDATA_FILE        = searchdata.xml
     1277#SEARCHDATA_FILE        = searchdata.xml
    12781278
    12791279# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
     
    12821282# projects and redirect the results back to the right project.
    12831283
    1284 EXTERNAL_SEARCH_ID     =
     1284#EXTERNAL_SEARCH_ID     =
    12851285
    12861286# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
     
    12911291# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
    12921292
    1293 EXTRA_SEARCH_MAPPINGS  =
     1293#EXTRA_SEARCH_MAPPINGS  =
    12941294
    12951295#---------------------------------------------------------------------------
     
    13511351# standard footer. Notice: only use this tag if you know what you are doing!
    13521352
    1353 LATEX_FOOTER           =
     1353#LATEX_FOOTER           =
    13541354
    13551355# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
     
    13901390# http://en.wikipedia.org/wiki/BibTeX for more info.
    13911391
    1392 LATEX_BIB_STYLE        = plain
     1392#LATEX_BIB_STYLE        = plain
    13931393
    13941394#---------------------------------------------------------------------------
     
    17411741# exceeded by 50% before the limit is enforced.
    17421742
    1743 UML_LIMIT_NUM_FIELDS   = 10
     1743#UML_LIMIT_NUM_FIELDS   = 10
    17441744
    17451745# If set to YES, the inheritance and collaboration graphs will show the
     
    18051805# visible. Older versions of IE do not have SVG support.
    18061806
    1807 INTERACTIVE_SVG        = NO
     1807#INTERACTIVE_SVG        = NO
    18081808
    18091809# The tag DOT_PATH can be used to specify the path where the dot tool can be
  • trunk/include/cf_base.h

    r116 r119  
    11/**
    2  * @file    cf_base.h
    3  * @author  myusgun <myusgun@gmail.com>
    4  * @version 0.1
     2 * \file    cf_base.h
     3 * \author  myusgun <myusgun@gmail.com>
     4 * \version 0.1
    55 *
    6  * @brief 기본 정의
     6 * \brief 기본 정의
    77 *
    8  * @mainpage
     8 * \mainpage
    99
    1010<h2 style="line-height: 10%;">Welcome to documentation page of libCF</h2>
  • trunk/include/cf_codec.h

    r116 r119  
    11/**
    2  * @file    cf_codec.h
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_codec.h
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief 데이터 변환
     5 * \brief 데이터 변환
    66 *
    7  * @example codec.c
     7 * \example codec.c
    88 */
    99#ifndef __CF_CODEC_H__
  • trunk/include/cf_debug.h

    r116 r119  
    11/**
    2  * @file    cf_debug.h
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_debug.h
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief 디버그 유틸
     5 * \brief 디버그 유틸
    66 *
    7  * @remarks
     7 * \remarks
    88 * 디버그 함수를 직접 호출하지 않고 정의된 매크로를 사용하면,
    99 * Preprocessor에 _DEBUG가 정의되어 있는 경우에 만
     
    1111 * 디버그 메시지는 stdout 및 stderr 등의 파일 포인터 출력을 지원함
    1212 *
    13  * @example debug.c
     13 * \example debug.c
    1414 */
    1515#ifndef __CF_DEBUG_H__
     
    3131 * 디버그 메시지를 지정된 파일 포인터로 출력
    3232 *
    33  & @param __fp  출력할 파일 포인터
    34  * @param __fmt 포맷 스트링
    35  * @param ...   가변 인자
     33 & \param __fp  출력할 파일 포인터
     34 * \param __fmt 포맷 스트링
     35 * \param ...   가변 인자
    3636 *
    37  * @see CF_Debug_Print
     37 * \see CF_Debug_Print
    3838 */
    3939# define CF_DEBUG_PRINT(__fp,__fmt,...) \
     
    4343 * 바이너리 데이터를 디버그 메시지와 함께 지정된 파일 포인터로 출력
    4444 *
    45  & @param __fp  출력할 파일 포인터
    46  * @param __bin 바이너리 데이터
    47  * @param __len 바이너리 길이
    48  * @param __fmt 포맷 스트링
    49  * @param ...   가변 인자
     45 & \param __fp  출력할 파일 포인터
     46 * \param __bin 바이너리 데이터
     47 * \param __len 바이너리 길이
     48 * \param __fmt 포맷 스트링
     49 * \param ...   가변 인자
    5050 *
    51  * @see CF_Debug_PrintBin
     51 * \see CF_Debug_PrintBin
    5252 */
    5353# define CF_DEBUG_PRINT_BIN(__fp,__bin,__len,__fmt,...) \
     
    5757 * 디버깅 모듈 초기화
    5858 *
    59  * @see CF_Debug_Initialize
     59 * \see CF_Debug_Initialize
    6060 */
    6161# define CF_DEBUG_INITIALIZE    \
     
    6565 * 디버깅 모듈 해제
    6666 *
    67  * @see CF_Debug_Finalize
     67 * \see CF_Debug_Finalize
    6868 */
    6969# define CF_DEBUG_FINALIZE  \
     
    7373 * 함수에 진입
    7474 *
    75  * @see CF_Debug_EnterFunction
     75 * \see CF_Debug_EnterFunction
    7676 */
    7777# define CF_DEBUG_BEGIN_FUNCTION    \
     
    8181 * 함수에서 리턴
    8282 *
    83  * @see CF_Debug_LeaveFunction
     83 * \see CF_Debug_LeaveFunction
    8484 */
    8585# define CF_DEBUG_END_FUNCTION  \
     
    8989 * 콜스택 을 지정된 파일 포인터로 출력
    9090 *
    91  * @see CF_Debug_PrintCallStack
     91 * \see CF_Debug_PrintCallStack
    9292 */
    9393# define CF_DEBUG_PRINT_CALLSTACK(__fp) \
  • trunk/include/cf_error.h

    r116 r119  
    11/**
    2  * @file    cf_error.h
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_error.h
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief 오류코드 모음
     5 * \brief 오류코드 모음
    66 */
    77#ifndef __CF_ERROR_H__
  • trunk/include/cf_file.h

    r116 r119  
    11/**
    2  * @file    cf_file.h
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_file.h
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief 파일 입출력
     5 * \brief 파일 입출력
    66 *
    7  * @example file.c
     7 * \example file.c
    88 */
    99#ifndef __CF_FILE_H__
  • trunk/include/cf_list.h

    r116 r119  
    11/**
    2  * @file    cf_list.h
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_list.h
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief 연결 리스트
     5 * \brief 연결 리스트
    66 *
    7  * @example list.c
     7 * \example list.c
    88 */
    99#ifndef __CF_LIST_H__
  • trunk/include/cf_log.h

    r116 r119  
    11/**
    2  * @file    cf_log.h
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_log.h
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief 로그
     5 * \brief 로그
    66 *
    7  * @remarks
     7 * \remarks
    88 * 매핑 ID 값을 이용하여 해당 로그에 기록 <br />
    99 * 로그 레벨을 적용할 때도 용이하며 define 이나 enumeration 등을 활용하면 좋음
    1010 *
    11  * @example log.c
     11 * \example log.c
    1212 */
    1313#ifndef __CF_LOG_H__
  • trunk/include/cf_queue.h

    r116 r119  
    11/**
    2  * @file    cf_queue.h
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_queue.h
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief 큐
     5 * \brief 큐
    66 *
    7  * @example queue.c
     7 * \example queue.c
    88 */
    99#ifndef __CF_QUEUE_H__
  • trunk/include/cf_socket.h

    r116 r119  
    11/**
    2  * @file    cf_socket.h
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_socket.h
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief TCP 소켓 지원
     5 * \brief TCP 소켓 지원
    66 *
    7  * @example socket.c
     7 * \example socket.c
    88 */
    99#ifndef __CF_SOCKET_H__
  • trunk/include/cf_stack.h

    r116 r119  
    11/**
    2  * @file    cf_stack.h
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_stack.h
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief 스택
     5 * \brief 스택
    66 *
    7  * @example stack.c
     7 * \example stack.c
    88 */
    99#ifndef __CF_STACK_H__
  • trunk/include/cf_thread.h

    r116 r119  
    11/**
    2  * @file    cf_thread.h
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_thread.h
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief 멀티스레드 및 뮤텍스 지원
     5 * \brief 멀티스레드 및 뮤텍스 지원
    66 *
    7  * @example thread.c
     7 * \example thread.c
    88 */
    99#ifndef __CF_THREAD_H__
  • trunk/makeinclude/platform.mk

    r97 r119  
    77UNAME_V := $(shell uname -v)
    88UNAME_A := $(shell uname -a)
     9DOXYGEN := $(shell which doxygen)
    910
    1011#------------------------------------------------------------
    1112# set options
    1213#------------------------------------------------------------
    13 ifeq ($(DEBUG), true)
     14ifeq ($(DEBUG), YES)
    1415    DEFS = -D_DEBUG
    1516    FLAG = -g
  • trunk/makeinclude/userdefine.mk

    r73 r119  
    11#------------------------------------------------------------
    2 # user define
     2# user definition
    33#------------------------------------------------------------
    4 VER     = 64
    5 DEBUG   = true
     4
     5# os-version
     6# > 32 or 64
     7VER             = 64
     8
     9# compile with debugging flag and definition
     10# > YES or NO
     11DEBUG           = YES
     12
     13# create doxygen documents automatically
     14# > YES or NO
     15DOXYGEN_CREATE  = YES
  • trunk/src/cf_codec.c

    r117 r119  
    11/**
    2  * @file    cf_codec.c
    3  * @author  myusgun <myusgun@gmail.com>
    4  *
    5  * @brief 데이터 변환 구현
     2 * \file    cf_codec.c
     3 * \author  myusgun <myusgun@gmail.com>
     4 *
     5 * \brief 데이터 변환 구현
    66 */
    77#include "cf_codec.h"
     
    7272 * hex-encode
    7373 *
    74  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    75  *
    76  * @param bin   바이너리 데이터
    77  * @param len   바이너리 데이터의 길이
    78  * @param hex   16진수 문자열을 저장할 주소
    79  *
    80  * @remarks
     74 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     75 *
     76 * \param bin   바이너리 데이터
     77 * \param len   바이너리 데이터의 길이
     78 * \param hex   16진수 문자열을 저장할 주소
     79 *
     80 * \remarks
    8181 * hex는 할당된 메모리이며, 크기는 '\0'를 제외하고 len * 2
    8282 */
     
    112112 * hex-decode
    113113 *
    114  * @return 성공 시, 디코딩된 바이너리 데이터의 길이; 실패 시, 오류 코드
    115  *
    116  * @param hex   16진수 문자열
    117  * @param bin   바이너리 데이터를 저장할 주소
    118  * @param len   바이너리 데이터의 길이를 저장할 주소
    119  *
    120  * @remarks
     114 * \return 성공 시, 디코딩된 바이너리 데이터의 길이; 실패 시, 오류 코드
     115 *
     116 * \param hex   16진수 문자열
     117 * \param bin   바이너리 데이터를 저장할 주소
     118 * \param len   바이너리 데이터의 길이를 저장할 주소
     119 *
     120 * \remarks
    121121 * bin는 할당된 메모리이며, 크기는 strlen (hex) / 2
    122122 */
     
    178178 * Base64-encode
    179179 *
    180  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    181  *
    182  * @param bin       바이너리 데이터
    183  * @param len       바이너리 데이터 길이
    184  * @param base64    base64 문자열을 저장할 주소
    185  *
    186  * @remarks
     180 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     181 *
     182 * \param bin       바이너리 데이터
     183 * \param len       바이너리 데이터 길이
     184 * \param base64    base64 문자열을 저장할 주소
     185 *
     186 * \remarks
    187187 * base64는 할당된 메모리이며, 크기는 '\0'를 제외하고 ((len + 2) / 3) * 4
    188188 */
     
    241241 * Base64-decode
    242242 *
    243  * @return 성공 시, 디코딩된 바이너리 데이터의 길이; 실패 시, 오류 코드
    244  *
    245  * @param base64    base64 문자열
    246  * @param bin       바이너리 데이터를 저장할 주소
    247  * @param len       바이너리 데이터의 길이를 저장할 주소
    248  *
    249  * @remarks
     243 * \return 성공 시, 디코딩된 바이너리 데이터의 길이; 실패 시, 오류 코드
     244 *
     245 * \param base64    base64 문자열
     246 * \param bin       바이너리 데이터를 저장할 주소
     247 * \param len       바이너리 데이터의 길이를 저장할 주소
     248 *
     249 * \remarks
    250250 * base64는 할당된 메모리이며, 크기는 (strlen (base64)) / 4 * 3
    251251 */
  • 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
  • trunk/src/cf_file.c

    r117 r119  
    11/**
    2  * @file    cf_file.c
    3  * @author  myusgun <myusgun@gmail.com>
    4  *
    5  * @brief 파일 입출력 구현
     2 * \file    cf_file.c
     3 * \author  myusgun <myusgun@gmail.com>
     4 *
     5 * \brief 파일 입출력 구현
    66 */
    77#include "cf_file.h"
     
    7272 * 파일 열기
    7373 *
    74  * @return 성공 시, 파일 디스크립터; 실패 시, 오류 코드
    75  *
    76  * @param path  파일 경로
    77  * @param flag  파일 열기 플래그
    78  *
    79  * @see CF_FILE_FLAG
     74 * \return 성공 시, 파일 디스크립터; 실패 시, 오류 코드
     75 *
     76 * \param path  파일 경로
     77 * \param flag  파일 열기 플래그
     78 *
     79 * \see CF_FILE_FLAG
    8080 */
    8181int
     
    100100 * 파일 생성
    101101 *
    102  * @return 성공 시, 파일 디스크립터; 실패 시, 오류 코드
    103  *
    104  * @param path 파일 경로
     102 * \return 성공 시, 파일 디스크립터; 실패 시, 오류 코드
     103 *
     104 * \param path 파일 경로
    105105 */
    106106int
     
    122122 * 파일 닫기
    123123 *
    124  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    125  *
    126  * @param fd 파일 디스크립터
     124 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     125 *
     126 * \param fd 파일 디스크립터
    127127 */
    128128int
     
    143143 * 파일 읽기
    144144 *
    145  * @return 성공 시, 읽은 바이트 수; 실패 시, 오류 코드
    146  *
    147  * @param fd    파일 디스크립터
    148  * @param buf   데이터를 저장할 메모리
    149  * @param len   데이터를 저장할 메모리의 크기
     145 * \return 성공 시, 읽은 바이트 수; 실패 시, 오류 코드
     146 *
     147 * \param fd    파일 디스크립터
     148 * \param buf   데이터를 저장할 메모리
     149 * \param len   데이터를 저장할 메모리의 크기
    150150 */
    151151int
     
    169169 * 파일 쓰기
    170170 *
    171  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    172  *
    173  * @param fd    파일 디스크립터
    174  * @param buf   데이터가 저장된 메모리
    175  * @param len   쓸 데이터의 길이
     171 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     172 *
     173 * \param fd    파일 디스크립터
     174 * \param buf   데이터가 저장된 메모리
     175 * \param len   쓸 데이터의 길이
    176176 */
    177177int
     
    195195 * 파일 크기 얻기
    196196 *
    197  * @return 성공 시, 파일 크기; 실패 시, 오류 코드
    198  *
    199  * @param path 파일 경로
     197 * \return 성공 시, 파일 크기; 실패 시, 오류 코드
     198 *
     199 * \param path 파일 경로
    200200 */
    201201int
     
    223223 * 파일 및 디렉터리 존재 여부 검사
    224224 *
    225  * @return 존재 시, CF_TRUE; 아니면, CF_FALSE
    226  *
    227  * @param path 파일 및 디렉터리 경로
     225 * \return 존재 시, CF_TRUE; 아니면, CF_FALSE
     226 *
     227 * \param path 파일 및 디렉터리 경로
    228228 */
    229229CF_BOOL
     
    236236 * 디렉터리 생성
    237237 *
    238  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    239  *
    240  * @param path 생성할 디렉터리 경로
     238 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     239 *
     240 * \param path 생성할 디렉터리 경로
    241241 */
    242242int
  • 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
  • trunk/src/cf_local.h

    r109 r119  
    11/**
    2  * @file    cf_local.h
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_local.h
     3 * \author  myusgun <myusgun@gmail.com>
    44 */
    55#ifndef __CF_LOCAL_H__
  • 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
  • trunk/src/cf_queue.c

    r117 r119  
    11/**
    2  * @file    cf_queue.c
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_queue.c
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief 큐 구현
     5 * \brief 큐 구현
    66 */
    77#include "cf_queue.h"
     
    1414 * 큐 컨텍스트 생성
    1515 *
    16  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     16 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    1717 *
    18  * @param ctx 큐 컨텍스트 포인터
     18 * \param ctx 큐 컨텍스트 포인터
    1919 */
    2020int
     
    2727 * 큐 컨텍스트 해제
    2828 *
    29  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     29 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    3030 *
    31  * @param ctx 큐 컨텍스트
     31 * \param ctx 큐 컨텍스트
    3232 */
    3333int
     
    4040 * 큐에 삽입
    4141 *
    42  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     42 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    4343 *
    44  * @param ctx       큐 컨텍스트
    45  * @param element   데이터 주소
     44 * \param ctx       큐 컨텍스트
     45 * \param element   데이터 주소
    4646 */
    4747int
     
    6363 * 큐에서 꺼내기
    6464 *
    65  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     65 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    6666 *
    67  * @param ctx       큐 컨텍스트
    68  * @param element   데이터 주소
     67 * \param ctx       큐 컨텍스트
     68 * \param element   데이터 주소
    6969 */
    7070int
     
    9090 * 큐 처음의 데이터 조회
    9191 *
    92  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     92 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    9393 *
    94  * @param ctx       큐 컨텍스트
    95  * @param element   데이터 주소
     94 * \param ctx       큐 컨텍스트
     95 * \param element   데이터 주소
    9696 */
    9797int
     
    113113 * 큐에 등록된 항목의 수를 가져옴
    114114 *
    115  * @return 성공 시, 항목 수; 실패 시, 오류 코드
     115 * \return 성공 시, 항목 수; 실패 시, 오류 코드
    116116 *
    117  * @param ctx 큐 컨텍스트
     117 * \param ctx 큐 컨텍스트
    118118 */
    119119int
  • trunk/src/cf_socket.c

    r117 r119  
    11/**
    2  * @file    cf_socket.c
    3  * @author  myusgun <myusgun@gmail.com>
    4  *
    5  * @brief TCP 소켓 구현
     2 * \file    cf_socket.c
     3 * \author  myusgun <myusgun@gmail.com>
     4 *
     5 * \brief TCP 소켓 구현
    66 */
    77#include "cf_socket.h"
     
    136136 * 소켓의 초기화 상태 확인
    137137 *
    138  * @return 초기화 된 경우, CF_TRUE; 그렇지 않은 경우, CF_FALSE
     138 * \return 초기화 된 경우, CF_TRUE; 그렇지 않은 경우, CF_FALSE
    139139 */
    140140CF_BOOL
     
    147147 * 소켓 초기화
    148148 *
    149  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     149 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    150150 */
    151151int
     
    165165 * 소켓 해제
    166166 *
    167  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     167 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    168168 */
    169169int
     
    183183 * 소켓 닫기
    184184 *
    185  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    186  *
    187  * @param sock 소켓
     185 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     186 *
     187 * \param sock 소켓
    188188 */
    189189int
     
    205205 * 소켓 옵션 설정
    206206 *
    207  * @return 성공 시 CF_OK; 실패 시, 오류 코드
    208  *
    209  * @param sock      소켓
    210  * @param optname   옵션 이름
    211  * @param optval    설정할 옵션 값의 메모리
    212  * @param optlen    설정할 옵션의 길이
     207 * \return 성공 시 CF_OK; 실패 시, 오류 코드
     208 *
     209 * \param sock      소켓
     210 * \param optname   옵션 이름
     211 * \param optval    설정할 옵션 값의 메모리
     212 * \param optlen    설정할 옵션의 길이
    213213 */
    214214int
     
    240240 * 소켓 옵션 얻기
    241241 *
    242  * @return 성공 시 CF_OK; 실패 시, 오류 코드
    243  *
    244  * @param sock      소켓
    245  * @param optname   옵션 이름
    246  * @param optval    옵션 값을 가져올 메모리
    247  * @param optlen    옵션 길이를 가져올 메모리
     242 * \return 성공 시 CF_OK; 실패 시, 오류 코드
     243 *
     244 * \param sock      소켓
     245 * \param optname   옵션 이름
     246 * \param optval    옵션 값을 가져올 메모리
     247 * \param optlen    옵션 길이를 가져올 메모리
    248248 */
    249249int
     
    275275 * 소켓 연결
    276276 *
    277  * @return 성공 시, 연결된 소켓; 실패 시, 오류 코드
    278  *
    279  * @param ip        연결할 호스트의 주소 (도메인 이름 가능)
    280  * @param port      연결할 호스트의 포트번호
     277 * \return 성공 시, 연결된 소켓; 실패 시, 오류 코드
     278 *
     279 * \param ip        연결할 호스트의 주소 (도메인 이름 가능)
     280 * \param port      연결할 호스트의 포트번호
    281281 */
    282282int
     
    290290 * 타임아웃 동안 소켓 연결
    291291 *
    292  * @return 성공 시, 연결된 소켓; 실패 시, 오류 코드
    293  *
    294  * @param ip        연결할 호스트의 주소 (도메인 이름 가능)
    295  * @param port      연결할 호스트의 포트번호
    296  * @param timeout   타임아웃 (초)
    297  *
    298  * @see CF_SOCKET_NO_TIMEOUT
     292 * \return 성공 시, 연결된 소켓; 실패 시, 오류 코드
     293 *
     294 * \param ip        연결할 호스트의 주소 (도메인 이름 가능)
     295 * \param port      연결할 호스트의 포트번호
     296 * \param timeout   타임아웃 (초)
     297 *
     298 * \see CF_SOCKET_NO_TIMEOUT
    299299 */
    300300int
     
    422422 * 서버 열기
    423423 *
    424  * @return 성공 시, 서버 소켓; 실패 시, 오류 코드
    425  *
    426  * @param port      서버 포트
    427  * @param backlog   listen 시의 backlog 수
     424 * \return 성공 시, 서버 소켓; 실패 시, 오류 코드
     425 *
     426 * \param port      서버 포트
     427 * \param backlog   listen 시의 backlog 수
    428428 */
    429429int
     
    480480 * 소켓 연결
    481481 *
    482  * @return 성공 시, 연결된 소켓; 실패 시, 오류 코드
    483  *
    484  * @param sock  서버 소켓
    485  *
    486  * @see CF_Socket_HostInfo
     482 * \return 성공 시, 연결된 소켓; 실패 시, 오류 코드
     483 *
     484 * \param sock  서버 소켓
     485 *
     486 * \see CF_Socket_HostInfo
    487487 */
    488488int
     
    505505 * 데이터 송신
    506506 *
    507  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    508  *
    509  * @param sock  소켓
    510  * @param buf   송신할 데이터
    511  * @param len   송신할 데이터의 길이
     507 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     508 *
     509 * \param sock  소켓
     510 * \param buf   송신할 데이터
     511 * \param len   송신할 데이터의 길이
    512512 */
    513513int
     
    522522 * 타임아웃 동안 데이터 송신
    523523 *
    524  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    525  *
    526  * @param sock      소켓
    527  * @param buf       송신할 데이터
    528  * @param len       송신할 데이터의 길이
    529  * @param timeout   타임아웃 (초)
    530  *
    531  * @see CF_SOCKET_NO_TIMEOUT
     524 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     525 *
     526 * \param sock      소켓
     527 * \param buf       송신할 데이터
     528 * \param len       송신할 데이터의 길이
     529 * \param timeout   타임아웃 (초)
     530 *
     531 * \see CF_SOCKET_NO_TIMEOUT
    532532 */
    533533int
     
    551551 * 데이터 수신
    552552 *
    553  * @return 성공 시, 수신한 데이터의 길이; 실패 시, 오류 코드
    554  *
    555  * @param sock  소켓
    556  * @param buf   데이터를 수신할 버퍼
    557  * @param len   데이터를 수신할 버퍼의 최대 크기
     553 * \return 성공 시, 수신한 데이터의 길이; 실패 시, 오류 코드
     554 *
     555 * \param sock  소켓
     556 * \param buf   데이터를 수신할 버퍼
     557 * \param len   데이터를 수신할 버퍼의 최대 크기
    558558 */
    559559int
     
    568568 * 타임아웃 동안 데이터 수신
    569569 *
    570  * @return 성공 시, 수신한 데이터의 길이; 실패 시, 오류 코드
    571  *
    572  * @param sock      소켓
    573  * @param buf       데이터를 수신할 버퍼
    574  * @param len       데이터를 수신할 버퍼의 최대 크기
    575  * @param timeout   타임아웃 (초)
    576  *
    577  * @see CF_SOCKET_NO_TIMEOUT
     570 * \return 성공 시, 수신한 데이터의 길이; 실패 시, 오류 코드
     571 *
     572 * \param sock      소켓
     573 * \param buf       데이터를 수신할 버퍼
     574 * \param len       데이터를 수신할 버퍼의 최대 크기
     575 * \param timeout   타임아웃 (초)
     576 *
     577 * \see CF_SOCKET_NO_TIMEOUT
    578578 */
    579579int
  • trunk/src/cf_stack.c

    r117 r119  
    11/**
    2  * @file    cf_stack.c
    3  * @author  myusgun <myusgun@gmail.com>
     2 * \file    cf_stack.c
     3 * \author  myusgun <myusgun@gmail.com>
    44 *
    5  * @brief 스택 구현
     5 * \brief 스택 구현
    66 */
    77#include "cf_stack.h"
     
    1414 * 스택 컨텍스트 생성
    1515 *
    16  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     16 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    1717 *
    18  * @param ctx 스택 컨텍스트 포인터
     18 * \param ctx 스택 컨텍스트 포인터
    1919 */
    2020int
     
    2727 * 스택 컨텍스트 해제
    2828 *
    29  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     29 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    3030 *
    31  * @param ctx 스택 컨텍스트
     31 * \param ctx 스택 컨텍스트
    3232 */
    3333int
     
    4040 * 스택에 삽입
    4141 *
    42  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     42 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    4343 *
    44  * @param ctx       스택 컨텍스트
    45  * @param element   데이터 주소
     44 * \param ctx       스택 컨텍스트
     45 * \param element   데이터 주소
    4646 */
    4747int
     
    6363 * 스택에서 꺼내기
    6464 *
    65  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     65 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    6666 *
    67  * @param ctx       스택 컨텍스트
    68  * @param element   데이터 주소
     67 * \param ctx       스택 컨텍스트
     68 * \param element   데이터 주소
    6969 */
    7070int
     
    9090 * 스택 최상위의 데이터 조회
    9191 *
    92  * @return 성공 시, CF_OK; 실패 시, 오류 코드
     92 * \return 성공 시, CF_OK; 실패 시, 오류 코드
    9393 *
    94  * @param ctx       스택 컨텍스트
    95  * @param element   데이터 주소
     94 * \param ctx       스택 컨텍스트
     95 * \param element   데이터 주소
    9696 */
    9797int
     
    113113 * 스택에 등록된 항목의 수를 가져옴
    114114 *
    115  * @return 성공 시, 항목 수; 실패 시, 오류 코드
     115 * \return 성공 시, 항목 수; 실패 시, 오류 코드
    116116 *
    117  * @param ctx 스택 컨텍스트
     117 * \param ctx 스택 컨텍스트
    118118 */
    119119int
  • trunk/src/cf_thread.c

    r117 r119  
    11/**
    2  * @file    cf_thread.c
    3  * @author  myusgun <myusgun@gmail.com>
    4  *
    5  * @brief 멀티 스레드 및 뮤텍스 구현
     2 * \file    cf_thread.c
     3 * \author  myusgun <myusgun@gmail.com>
     4 *
     5 * \brief 멀티 스레드 및 뮤텍스 구현
    66 */
    77#include "cf_thread.h"
     
    5151 * 스레드를 생성
    5252 *
    53  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    54  *
    55  * @param threadID  스레드 아이디 주소
    56  * @param callback  스레드 워커 함수 이름
    57  * @param arg       스레드 함수로 전달할 인자
    58  *
    59  * @remarks
     53 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     54 *
     55 * \param threadID  스레드 아이디 주소
     56 * \param callback  스레드 워커 함수 이름
     57 * \param arg       스레드 함수로 전달할 인자
     58 *
     59 * \remarks
    6060 * pthread(POSIX Thread)에서 지원되는 스케줄링 정책은 SCHED_OTHER, SCHED_FIFO, SCHED_RR 등이 존재 <br />
    6161 * 일반적으로 설정되는 스케줄링 정책의 기본값은 SCHED_OTHER이며, 솔라리스 환경에서 SCHED_OTHER는 TS(timesharing) 방식으로 명시되어 있음 <br />
     
    124124 * 스레드 아이디를 해제
    125125 *
    126  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    127  *
    128  * @param threadID 스레드 아이디 주소
    129  *
    130  * @remarks 스레드 아이디를 해제하는 것이며 워커 스레드가 종료되지 않음
     126 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     127 *
     128 * \param threadID 스레드 아이디 주소
     129 *
     130 * \remarks 스레드 아이디를 해제하는 것이며 워커 스레드가 종료되지 않음
    131131 */
    132132int
     
    141141 * 스레드가 종료될 때 까지 대기
    142142 *
    143  * @return CF_OK 반환
    144  *
    145  * @param threadID 스레드 아이디 주소
     143 * \return CF_OK 반환
     144 *
     145 * \param threadID 스레드 아이디 주소
    146146 */
    147147int
     
    163163 * 뮤텍스 생성
    164164 *
    165  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    166  *
    167  * @param mutex 뮤텍스 아이디 주소
    168  *
    169  * @see CF_Thread_Create
     165 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     166 *
     167 * \param mutex 뮤텍스 아이디 주소
     168 *
     169 * \see CF_Thread_Create
    170170 */
    171171int
     
    194194 * 뮤텍스 해제
    195195 *
    196  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    197  *
    198  * @param mutex 뮤텍스 아이디 주소
     196 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     197 *
     198 * \param mutex 뮤텍스 아이디 주소
    199199 */
    200200int
     
    213213 * 뮤텍스 잠금
    214214 *
    215  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    216  *
    217  * @param mutex 뮤텍스 아이디 주소
     215 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     216 *
     217 * \param mutex 뮤텍스 아이디 주소
    218218 */
    219219int
     
    234234 * 뮤텍스 잠금 해제
    235235 *
    236  * @return 성공 시, CF_OK; 실패 시, 오류 코드
    237  *
    238  * @param mutex 뮤텍스 아이디 주소
     236 * \return 성공 시, CF_OK; 실패 시, 오류 코드
     237 *
     238 * \param mutex 뮤텍스 아이디 주소
    239239 */
    240240int
  • trunk/src/makefile

    r109 r119  
    2727SRCS            = $(addsuffix .$(SOURCE_TYPE),$(FILES))
    2828OBJS            = $(addprefix $(OBJ_PATH)/,$(addsuffix .o,$(FILES)))
     29DOXYGEN_PATH    = ../docs
     30DOXYGEN_FILE    = $(DOXYGEN_PATH)/doxyfile
    2931
    3032INCLUDES        = -I../include
     
    3335# label
    3436#----------------------------------------------------------
    35 all: $(OBJ_PATH) $(TARGET_PATH) $(TARGET)
     37all: $(OBJ_PATH) $(TARGET_PATH) $(TARGET) doxygen
    3638    @echo ========== Complete LIBCF compilation ==========
    3739$(TARGET_PATH): dummy
     
    5153    $(CC) $(CFLAGS) $(CDEFS) $(INCLUDES) -o $@ -c $?
    5254
     55# doxygen
     56doxygen: dummy
     57ifeq ($(DOXYGEN_CREATE),YES)
     58ifeq ($(DOXYGEN),)
     59    @echo "doxygen was not found."
     60else
     61    @echo "========== DOXYGEN DOCUMENTATION =========="
     62    cd $(DOXYGEN_PATH); $(DOXYGEN) $(DOXYGEN_FILE); cat warning.log;
     63endif
     64endif
     65
    5366clean: dummy
    5467    rm -rf $(TARGET_PATH) $(OBJ_PATH)
     68ifeq ($(DOXYGEN_CREATE),YES)
     69    rm -rf ../documentation
     70endif
    5571
    5672dummy:
    57 
Note: See TracChangeset for help on using the changeset viewer.