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: add -comments and new comment merger (#11221)

Browse Source
This commit is contained in:
Leo Developer
2021-08-19 09:20:43 +02:00
committed by GitHub
parent 337c325109
commit 7bffabbce2
15 changed files with 208 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/docs.md
View File

@@ -4111,6 +4111,17 @@ An overview of the module must be placed in the first comment right after the mo
To generate documentation use vdoc, for example `v doc net.http`.
### Newlines in Documentation Comments
Comments spanning multiple lines are merged together using spaces, unless
- the line is empty
- the line ends with a `.` (end of sentence)
- the line is contains purely of at least 3 of `-`, `=`, `_`, `*`, `~` (horizontal rule)
- the line starts with at least one `#` followed by a space (header)
- the line starts and ends with a `|` (table)
- the line starts with `- ` (list)
## Tools
### v fmt