Merge pull request #706 from pouchrobot/auto-doc-2019-07-23

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

docs/cli_reference/dfdaemon.md

@@ -29,10 +29,10 @@ dfdaemon [flags]
       --registry string     registry mirror url, which will override the registry mirror settings in the config file if presented (default "https://index.docker.io")
       --urlfilter string    filter specified url fields (default "Signature&Expires&OSSAccessKeyId")
       --verbose             verbose
-  -v, --version             version
 ```
 
 ### SEE ALSO
 
 * [dfdaemon gen-doc](dfdaemon_gen-doc.md)	 - Generate Document for dfdaemon command line tool with MarkDown format
+* [dfdaemon version](dfdaemon_version.md)	 - Show the current version of dfdaemon
 

docs/cli_reference/dfdaemon_version.md

@@ -0,0 +1,33 @@
+## dfdaemon version
+
+Show the current version of dfdaemon
+
+### Synopsis
+
+Display the version and build information of Dragonfly dfdaemon, including GoVersion, OS, Arch, Version, BuildDate and GitCommit.
+
+```
+dfdaemon version [flags]
+```
+
+### Examples
+
+```
+dfdaemon, version  0.4.1
+  Git commit:     6fd5c8f
+  Build date:     20190717-15:57:52
+  Go version:     go1.12.6
+  OS/Arch:        linux/amd64
+
+```
+
+### Options
+
+```
+  -h, --help   help for version
+```
+
+### SEE ALSO
+
+* [dfdaemon](dfdaemon.md)	 - The dfdaemon is a proxy that intercepts image download requests.
+

docs/cli_reference/dfget.md

@@ -44,13 +44,15 @@ download SUCCESS(0) cost:0.026s length:141898 reason:0
       --header strings        http header, eg: --header='Accept: *' --header='Host: abc'
   -h, --help                  help for dfget
   -i, --identifier string     The usage of identifier is making different downloading tasks generate different downloading task IDs even if they have the same URLs. conflict with --md5.
+      --ip string             IP address that server will listen on
   -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
       --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")
+      --port int              port number that server will listen on
   -b, --showbar               show progress bar, it is conflict with '--console'
   -e, --timeout int           Timeout set for file downloading task. If dfget has not finished downloading all pieces of file before --timeout, the dfget will throw an error and exit
       --totallimit string     network bandwidth rate limit for the whole host, in format of 20M/m/K/k
@@ -62,5 +64,5 @@ download SUCCESS(0) cost:0.026s length:141898 reason:0
 
 * [dfget gen-doc](dfget_gen-doc.md)	 - Generate Document for dfget command line tool with MarkDown format
 * [dfget server](dfget_server.md)	 - Launch a peer server for uploading files.
-* [dfget version](dfget_version.md)	 - Show the current version
+* [dfget version](dfget_version.md)	 - Show the current version of dfget
 

docs/cli_reference/dfget_version.md

@@ -1,15 +1,26 @@
 ## dfget version
 
-Show the current version
+Show the current version of dfget
 
 ### Synopsis
 
-Show the current version
+Display the version and build information of Dragonfly dfget, including GoVersion, OS, Arch, Version, BuildDate and GitCommit.
 
 ```
 dfget version [flags]
 ```
 
+### Examples
+
+```
+dfget, version  0.4.1
+  Git commit:     6fd5c8f
+  Build date:     20190717-15:57:52
+  Go version:     go1.12.6
+  OS/Arch:        linux/amd64
+
+```
+
 ### Options
 
 ```