소스 검색

Added first parameter table

Lammert Bies 8 년 전
부모
커밋
76dc6e2781
1개의 변경된 파일8개의 추가작업 그리고 5개의 파일을 삭제
  1. 8 5
      docs/APIReference.md

+ 8 - 5
docs/APIReference.md

@@ -12,11 +12,15 @@ Work in progress...
 
 #### Parameters
 
-  - `unsigned feature` - a value indicating the feature to be checked
+| Type | Parameter | Description |
+| :--- | :--- | :--- |
+| `unsigned` | `feature` | A value indicating the feature to be checked |
 
 #### Returns
 
-  - `unsigned` - a value indicating if a feature is available
+| Type | Description |
+| :--- | :--- |
+| `unsigned` | A value indicating if a feature is available. A positive value indicates available, while 0 is returned for an unavailable feature |
 
 ##### Description
 
@@ -25,9 +29,8 @@ The function `mg_check_feature()` can be called from an application program to c
 The following parameter values can be used:
 
 | Value | Compilation option | Description |
-| --- | --- | --- |
-| **1** | NO_FILES | *Able to serve files*.  
-If this feature is available, the webserver is able to serve files directly from a directory tree. |
+| :---: | :--- | :--- |
+| **1** | NO_FILES | *Able to serve files*.  If this feature is available, the webserver is able to serve files directly from a directory tree. |
 | **2** | NO_SSL | *Support for HTTPS*. If this feature is available, the webserver van use encryption in the client-server connection. SSLv2, SSLv3, TLSv1.0, TLSv1.1 and TLSv1.2 are supported depending on the SSL library CivetWeb has been compiled with, but which protocols are used effectively when the server is running is dependent on the options used when the server is started. |
 | **4** | NO_CGI | *Support for CGI*. If this feature is available, external CGI scripts can be called by the webserver. |
 | **8** | USE_IPV6 | *Support IPv6*. The CivetWeb library is capable of communicating over both IPv4 and IPv6, but IPv6 support is only available if it has been enabled at compile time. |