Merge pull request #761 from pouchrobot/auto-doc-2019-08-01

docs: auto generate Dragonfly cli/api/contributors docs via code

CONTRIBUTORS

@@ -1,7 +1,7 @@
 # This file lists all contributors having contributed to this project.
 # For how it is generated, see command "git log --format='%aN <%aE>' | sort -uf".
 
-Alan <[email protected]>
+alan <[email protected]>
 Alibaba OSS <[email protected]>
 aliwaredoc <[email protected]>
 Allen Sun <[email protected]>

docs/api_reference/apis.md

@@ -917,7 +917,7 @@ detailed information about task in supernode.
 |**path**  <br>*optional*|path is used in one peer A for uploading functionality. When peer B hopes<br>to get piece C from peer A, B must provide a URL for piece C.<br>Then when creating a task in supernode, peer A must provide this URL in request.|string|
 |**port**  <br>*optional*|when registering, dfget will setup one uploader process. <br>This one acts as a server for peer pulling tasks.<br>This port is which this server listens on.  <br>**Minimum value** : `15000`  <br>**Maximum value** : `65000`|integer (int32)|
 |**rawURL**  <br>*optional*|The is the resource's URL which user uses dfget to download. The location of URL can be anywhere, LAN or WAN.<br>For image distribution, this is image layer's URL in image registry.<br>The resource url is provided by command line parameter.|string|
-|**superNodeIp**  <br>*optional*|IP address of supernode that the client can connect to|string (ipv4)|
+|**superNodeIp**  <br>*optional*|The address of supernode that the client can connect to|string|
 |**taskURL**  <br>*optional*|taskURL is generated from rawURL. rawURL may contains some queries or parameter, dfget will filter some queries via<br>--filter parameter of dfget. The usage of it is that different rawURL may generate the same taskID.|string|
 |**version**  <br>*optional*|version number of dfget binary.|string|
 

docs/cli_reference/dfdaemon.md

@@ -22,7 +22,7 @@ dfdaemon [flags]
       --keypem string       key.pem file path
       --localrepo string    temp output dir of dfdaemon (default "/root/.small-dragonfly/dfdaemon/data")
       --maxprocs int        the maximum number of CPUs that the dfdaemon can use (default 4)
-      --node strings        specify the addresses(IP:port) of supernodes that will be passed to dfget.
+      --node strings        specify the addresses(host:port) of supernodes that will be passed to dfget.
       --notbs               not try back source to download if throw exception (default true)
       --port uint           dfdaemon will listen the port (default 65001)
       --ratelimit string    net speed limit,format:xxxM/K (default "20M")

docs/cli_reference/dfdaemon_version.md

@@ -13,7 +13,7 @@ dfdaemon version [flags]
 ### Examples
 
 ```
-dfdaemon, version  0.4.1
+dfdaemon version  0.4.1
   Git commit:     6fd5c8f
   Build date:     20190717-15:57:52
   Go version:     go1.12.6

docs/cli_reference/dfget.md

@@ -48,7 +48,7 @@ download SUCCESS(0) cost:0.026s length:141898 reason:0
   -s, --locallimit string     network bandwidth rate limit for single download task, in format of 20M/m/K/k
   -m, --md5 string            md5 value input from user for the requested downloading file to enhance security
       --minrate string        minimal network bandwidth rate for downloading a file, in format of 20M/m/K/k
-  -n, --node strings          specify the addresses(IP:port) of supernodes
+  -n, --node strings          specify the addresses(host:port) of supernodes
       --notbs                 disable back source downloading for requested file when p2p fails to download it
   -o, --output string         Destination path which is used to store the requested downloading file. It must contain detailed directory and specific filename, for example, '/tmp/file.mp4'
   -p, --pattern string        download pattern, must be p2p/cdn/source, cdn and source do not support flag --totallimit (default "p2p")

docs/cli_reference/dfget_version.md

@@ -13,7 +13,7 @@ dfget version [flags]
 ### Examples
 
 ```
-dfget, version  0.4.1
+dfget version  0.4.1
   Git commit:     6fd5c8f
   Build date:     20190717-15:57:52
   Go version:     go1.12.6