v/cmd/v/help/doc.txt

32 lines
1.2 KiB
Plaintext
Raw Normal View History

Usage:
v doc [flags] [module_name / folder / V file] [symbol name]
Examples:
v doc os
v doc os File
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,
or Markdown format.
Options:
2020-06-06 17:41:44 +02:00
-all Includes private and public functions/methods/structs/consts/enums.
-f Specifies the output format to be used. Available formats are:
md/markdown, json, text, stdout and html/htm
2020-06-29 11:03:09 +02:00
-h, -help Prints this help text.
2020-06-06 17:41:44 +02:00
-m Generate docs for modules listed in that folder.
-o Specifies the output file/folder path where to store the generated docs.
Set it to "stdout" to print the output instead of saving the contents
to a file.
2020-06-29 11:03:09 +02:00
-readme Include README.md to docs if present.
-v Enables verbose logging. For debugging purposes.
2021-03-13 06:49:03 +01:00
-no-timestamp Omits the timestamp in the output file.
2020-06-29 11:03:09 +02:00
For HTML mode:
-inline-assets Embeds the contents of the CSS and JS assets into the webpage directly.
For plain text mode:
-l Show the locations of the generated signatures.