Changeset 119 in libcf for trunk/src/cf_socket.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_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
Note: See TracChangeset for help on using the changeset viewer.