|
Last change
on this file since 37 was 37, checked in by cheese, 11 years ago |
|
#1 add mainpage of doxygen documentation
|
|
File size:
1.6 KB
|
| Line | |
|---|
| 1 | /**
|
|---|
| 2 | * @file cf_base.h
|
|---|
| 3 | * @author myusgun <myusgun@gmail.com>
|
|---|
| 4 | * @version 0.1
|
|---|
| 5 | *
|
|---|
| 6 | * @mainpage
|
|---|
| 7 |
|
|---|
| 8 | <h2 style="line-height: 10%;">Welcome to documentation page of libCF</h2>
|
|---|
| 9 | - CFLibrary (cheese's foundation library)
|
|---|
| 10 |
|
|---|
| 11 | This documentation (suggested by nvdark) includes only manual of APIs.
|
|---|
| 12 |
|
|---|
| 13 | Please visit <a href="/trac/libcf">Trac</a> of libcf.
|
|---|
| 14 |
|
|---|
| 15 | <h3>supported functions</h3>
|
|---|
| 16 | <ol>
|
|---|
| 17 | <li> File I/O </li>
|
|---|
| 18 | <li> Socket </li>
|
|---|
| 19 | <li> Logging (advisor: vfire) </li>
|
|---|
| 20 | <li> Utilities for Debug </li>
|
|---|
| 21 | <li> Thread & Mutex </li>
|
|---|
| 22 | <li> ..more needs ? </li>
|
|---|
| 23 | </ol>
|
|---|
| 24 |
|
|---|
| 25 | 사츠키 하앜
|
|---|
| 26 |
|
|---|
| 27 | */
|
|---|
| 28 | #ifndef __CF_BASE_H__
|
|---|
| 29 | #define __CF_BASE_H__
|
|---|
| 30 |
|
|---|
| 31 | /** boolean 타입 */
|
|---|
| 32 | typedef enum {
|
|---|
| 33 | CF_FALSE = 0, /**< 거짓 */
|
|---|
| 34 | CF_TRUE = 1 /**< 참 */
|
|---|
| 35 | } E_CF_BOOL,
|
|---|
| 36 | /**
|
|---|
| 37 | * boolean 타입
|
|---|
| 38 | * @see E_CF_BOOL
|
|---|
| 39 | */
|
|---|
| 40 | CF_BOOL;
|
|---|
| 41 |
|
|---|
| 42 | /** 성공 시, 반환 값 */
|
|---|
| 43 | #define CF_OK 0
|
|---|
| 44 | /** 오류 코드 */
|
|---|
| 45 | #define CF_ERROR -1
|
|---|
| 46 |
|
|---|
| 47 | /** 파일 이름 및 경로 길이 */
|
|---|
| 48 | #define NAME_LENGTH 128
|
|---|
| 49 |
|
|---|
| 50 | /** 오류 코드 베이스 넘버 */
|
|---|
| 51 | #define CF_ERROR_BASE CF_ERROR * 1000
|
|---|
| 52 | /** @see cf_file.h */
|
|---|
| 53 | #define CF_ERROR_FILE CF_ERROR_BASE * 2
|
|---|
| 54 | /** @see cf_socket.h */
|
|---|
| 55 | #define CF_ERROR_SOCKET CF_ERROR_BASE * 3
|
|---|
| 56 | /** @see cf_thread.h */
|
|---|
| 57 | #define CF_ERROR_THREAD CF_ERROR_BASE * 4
|
|---|
| 58 | /** @see cf_thread.h */
|
|---|
| 59 | #define CF_ERROR_MUTEX CF_ERROR_BASE * 5
|
|---|
| 60 | /** @see cf_debug.h */
|
|---|
| 61 | #define CF_ERROR_DEBUG CF_ERROR_BASE * 6
|
|---|
| 62 | /** @see cf_log.h */
|
|---|
| 63 | #define CF_ERROR_LOG CF_ERROR_BASE * 7
|
|---|
| 64 |
|
|---|
| 65 | /** Windows 에서의 함수 EXPORT 구문 정의 */
|
|---|
| 66 | #ifdef _WIN32
|
|---|
| 67 | # define CF_EXPORT __declspec(dllexport)
|
|---|
| 68 | #else // #ifdef _WIN32
|
|---|
| 69 | # define CF_EXPORT
|
|---|
| 70 | #endif // #ifdef _WIN32
|
|---|
| 71 |
|
|---|
| 72 | #endif // #ifndef __CF_BASE_H__
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
