mirror/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2023-08-10 21:13:21 +03:00
Code Issues Projects Releases Wiki Activity

vdoc: help

Browse Source
This commit is contained in:
Daniel Däschle 2020-06-06 17:41:44 +02:00 committed by GitHub
parent fb6be080fb
commit 32463e94f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/tools/vdoc.v
View File

@ -629,7 +629,7 @@ fn (cfg DocConfig) get_resource(name string, minify bool) string {
fn main() { fn main() {
args := os.args[2..] args := os.args[2..]
if args.len == 0 || args[0] == 'help' { if args.len == 0 || args[0] in ['help', '-h', '--help'] {
os.system('${@VEXE} help doc') os.system('${@VEXE} help doc')
exit(0) exit(0)
} }

20
cmd/v/help/doc.txt
View File

@ -11,13 +11,13 @@ and prints or saves them to its desired format. It can generate HTML, JSON,
or Markdown format. or Markdown format.
Options: Options:
-all Includes private and public functions/methods/structs/consts/enums. -all Includes private and public functions/methods/structs/consts/enums.
-f Specifies the output format to be used. -f Specifies the output format to be used.
-inline-assets -inline-assets Embeds the contents of the CSS and JS assets into the webpage directly.
Embeds the contents of the CSS and JS assets into the webpage directly. -l Show the locations of the generated signatures. (For plaintext only)
-l Show the locations of the generated signatures. (For plaintext only) -m Generate docs for modules listed in that folder.
-m Generate docs for modules listed in that folder. -o Specifies the output file/folder path where to store the generated docs.
-o Specifies the output file/folder path where to store the generated docs. -s Serve HTML-generated docs via HTTP.
-s Serve HTML-generated docs via HTTP. -r Include README.md to docs if present.
-r Include README.md to docs if present. -v Enables verbose logging. For debugging purposes.
-v Enables verbose logging. For debugging purposes. -h, -help Prints this help text.