Преглед на файлове

Fix ftpserver documentation and some formating in httpserver.md (#3322)

Gregor Hartmann преди 3 години
родител
ревизия
4f6792773f
променени са 2 файла, в които са добавени 14 реда и са изтрити 17 реда
  1. 6 6
      docs/lua-modules/ftpserver.md
  2. 8 11
      docs/lua-modules/httpserver.md

+ 6 - 6
docs/lua-modules/ftpserver.md

@@ -34,7 +34,7 @@ This implementation is by [Terry Ellison](https://github.com/TerryE), but I wish
 Create the FTP server on the standard ports 20 and 21.  The global variable `FTP` is set to the server object.
 
 #### Syntax
-`FTP.createServer(user, pass[, dbgFlag])`
+`FTP:createServer(user, pass[, dbgFlag])`
 
 #### Parameters
 - `user`: Username for access to the server
@@ -46,14 +46,14 @@ Create the FTP server on the standard ports 20 and 21.  The global variable `FTP
 
 #### Example
 ```Lua
-require("ftpserver").createServer('user', 'password')
+require("ftpserver"):createServer('user', 'password')
 ```
 
 ## open()
 Wrapper to createServer() which also connects to the WiFi channel.
 
 #### Syntax
-`FTP.open(user, pass, ssid, wifipwd, dbgFlag)`
+`FTP:open(user, pass, ssid, wifipwd, dbgFlag)`
 
 #### Parameters
 - `user`: Username for access to the server
@@ -67,14 +67,14 @@ Wrapper to createServer() which also connects to the WiFi channel.
 
 #### Example
 ```Lua
-require("ftpserver").open('user', 'password', 'myWifi', 'wifiPassword')
+require("ftpserver"):open('user', 'password', 'myWifi', 'wifiPassword')
 ```
 
 ## close()
 Close down server including any sockets and return all resources to Lua. Note that this include removing the FTP global variable and package references.
 
 #### Syntax
-`FTP.close()`
+`FTP:close()`
 
 #### Parameters
 None
@@ -84,5 +84,5 @@ None
 
 #### Example
 ```Lua
-FTP.close()
+FTP:close()
 ```

+ 8 - 11
docs/lua-modules/httpserver.md

@@ -38,7 +38,6 @@ Callback function has 2 arguments: `req` (request) and `res` (response). The fir
 - `url`: Requested URL
 - `onheader`: assign a function to this value which will be called as soon as HTTP headers like `content-type` are available.
               This handler function has 3 parameters:
-
 	- `self`: `req` object
 	- `name`: Header name. Will allways be lowercase.
 	- `value`: Header value
@@ -51,20 +50,18 @@ Callback function has 2 arguments: `req` (request) and `res` (response). The fir
 The second object holds functions:
 
 - `send(self, data, [response_code])`: Function to send data to client. 
-  
-  - `self`: `res` object
-  - `data`: data to send (may be nil)
-  - `response_code`: the HTTP response code like `200`(default) or `404` (for example) *NOTE* if there are several calls with response_code given only the first one will be used. Any further codes given will be ignored.
+	- `self`: `res` object
+	- `data`: data to send (may be nil)
+	- `response_code`: the HTTP response code like `200`(default) or `404` (for example) *NOTE* if there are several calls with response_code given only the first one will be used. Any further codes given will be ignored.
   
 - `send_header(self, header_name, header_data)`: Function to send HTTP headers to client. This function will not be available after data has been sent. (It will be nil.)
-
-  - `self`: `res` object
-  - `header_name`: the HTTP header name
-  - `header_data`: the HTTP header data
+	- `self`: `res` object
+	- `header_name`: the HTTP header name
+	- `header_data`: the HTTP header data
 
 - `finish([data[, response_code]])`: Function to finalize connection, optionally sending data and return code.
 
-  - `data`: optional data to send on connection finalizing
-  - `response_code`: the HTTP response code like `200`(default) or `404` (for example) *NOTE* if there are several calls with response_code given only the first one will be used. Any further codes given will be ignored.
+	- `data`: optional data to send on connection finalizing
+	- `response_code`: the HTTP response code like `200`(default) or `404` (for example) *NOTE* if there are several calls with response_code given only the first one will be used. Any further codes given will be ignored.
 
 Full example can be found in [http-example.lua](../../lua_modules/http/http-example.lua)