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: rewrite usage, add new options + streamline process

Browse Source
This commit is contained in:
Ned Palacios
2020-06-05 15:59:26 +08:00
committed by GitHub
parent c9b395f9cf
commit 30e0bda434
5 changed files with 226 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,8 +1,10 @@
Usage:
v doc [flags] module_name output_file[.json|.md|.html]
v doc [flags] path_to_source.v output_file[.json|.md|.html]
v doc [flags] ./directory output_file[.json|.md|.html]
v doc [flags] . output_file[.json|.md|.html]
v doc [flags] [module_name / folder / V file]
Examples:
v doc os
v doc -o math.html math
v doc -m -f html vlib/
Generates the documentation of a given directory, module, or V source file
and prints or saves them to its desired format. It can generate HTML, JSON,
@ -10,7 +12,12 @@ or Markdown format.
Options:
-all Includes private and public functions/methods/structs/consts/enums.
-loc Show the locations of the generated signatures. (For plaintext only)
-f Specifies the output format to be used.
-inline-assets
Embeds the contents of the CSS and JS assets into the webpage directly.
-l Show the locations of the generated signatures. (For plaintext only)
-m Generate docs for modules listed in that folder.
-o Specifies the output file/folder path where to store the generated docs.
-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.