mirror of
https://github.com/vlang/v.git
synced 2025-09-12 08:57:09 -04:00
vdoc: update merge_doc_comments
so recent fixes extend to all output formats (#21289)
This commit is contained in:
parent
107c43a34d
commit
0b83ea77c9
@ -506,43 +506,12 @@ fn html_highlight(code string, tb &ast.Table) string {
|
|||||||
fn doc_node_html(dn doc.DocNode, link string, head bool, include_examples bool, tb &ast.Table) string {
|
fn doc_node_html(dn doc.DocNode, link string, head bool, include_examples bool, tb &ast.Table) string {
|
||||||
mut dnw := strings.new_builder(200)
|
mut dnw := strings.new_builder(200)
|
||||||
head_tag := if head { 'h1' } else { 'h2' }
|
head_tag := if head { 'h1' } else { 'h2' }
|
||||||
// Allow README.md to go through unescaped except for script tags
|
|
||||||
escaped_html := if head && is_module_readme(dn) {
|
|
||||||
readme_lines := dn.comments[0].text.split_into_lines()
|
|
||||||
mut merged_lines := []string{}
|
|
||||||
mut is_codeblock := false
|
|
||||||
for i := 0; i < readme_lines.len; i++ {
|
|
||||||
l := readme_lines[i]
|
|
||||||
nl := readme_lines[i + 1] or {
|
|
||||||
merged_lines << l
|
|
||||||
break
|
|
||||||
}
|
|
||||||
l_trimmed := l.trim_left('\x01').trim_space()
|
|
||||||
if l_trimmed.starts_with('```') {
|
|
||||||
is_codeblock = !is_codeblock
|
|
||||||
}
|
|
||||||
// -> if l_trimmed.len > 1 && (is_ul || is_ol)
|
|
||||||
is_list := l_trimmed.len > 1 && ((l_trimmed[1] == ` ` && l_trimmed[0] in [`*`, `-`])
|
|
||||||
|| (l_trimmed.len > 2 && l_trimmed[2] == ` ` && l_trimmed[1] == `.`
|
|
||||||
&& l_trimmed[0].is_digit()))
|
|
||||||
if !is_codeblock && l != '' && nl != '' && !is_list
|
|
||||||
&& !nl.trim_left('\x01').trim_space().starts_with('```') {
|
|
||||||
merged_lines << '${l} ${nl}'
|
|
||||||
i++
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
merged_lines << l
|
|
||||||
}
|
|
||||||
merged_lines.join_lines()
|
|
||||||
} else {
|
|
||||||
dn.merge_comments_without_examples()
|
|
||||||
}
|
|
||||||
mut renderer := markdown.HtmlRenderer{
|
mut renderer := markdown.HtmlRenderer{
|
||||||
transformer: &MdHtmlCodeHighlighter{
|
transformer: &MdHtmlCodeHighlighter{
|
||||||
table: tb
|
table: tb
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
md_content := markdown.render(escaped_html, mut renderer) or { '' }
|
md_content := markdown.render(dn.merge_comments_without_examples(), mut renderer) or { '' }
|
||||||
highlighted_code := html_highlight(dn.content, tb)
|
highlighted_code := html_highlight(dn.content, tb)
|
||||||
node_class := if dn.kind == .const_group { ' const' } else { '' }
|
node_class := if dn.kind == .const_group { ' const' } else { '' }
|
||||||
sym_name := get_sym_name(dn)
|
sym_name := get_sym_name(dn)
|
||||||
|
@ -255,7 +255,10 @@ List point 3
|
|||||||
- List point 2
|
- List point 2
|
||||||
- List point 3
|
- List point 3
|
||||||
|
|
||||||
1. Numbered markdown list point 1 2. List point 2 3. List point 3
|
1. Numbered markdown list point 1
|
||||||
|
2. List point 2
|
||||||
|
3. List point 3
|
||||||
|
|
||||||
|
|
||||||
[94mconst[39m omega = [94m3[39m [90m// should be first[39m
|
[94mconst[39m omega = [94m3[39m [90m// should be first[39m
|
||||||
[94mconst[39m alpha = [94m5[39m [90m// should be in the middle[39m
|
[94mconst[39m alpha = [94m5[39m [90m// should be in the middle[39m
|
||||||
|
@ -135,7 +135,10 @@ module main
|
|||||||
- List point 2
|
- List point 2
|
||||||
- List point 3
|
- List point 3
|
||||||
|
|
||||||
1. Numbered markdown list point 1 2. List point 2 3. List point 3
|
1. Numbered markdown list point 1
|
||||||
|
2. List point 2
|
||||||
|
3. List point 3
|
||||||
|
|
||||||
|
|
||||||
const omega = 3 // should be first
|
const omega = 3 // should be first
|
||||||
const alpha = 5 // should be in the middle
|
const alpha = 5 // should be in the middle
|
||||||
|
@ -63,9 +63,11 @@ pub fn merge_doc_comments(comments []DocComment) string {
|
|||||||
mut comment := ''
|
mut comment := ''
|
||||||
mut next_on_newline := true
|
mut next_on_newline := true
|
||||||
mut is_codeblock := false
|
mut is_codeblock := false
|
||||||
|
mut trimmed_indent := ''
|
||||||
for cmt in doc_comments.reverse() {
|
for cmt in doc_comments.reverse() {
|
||||||
line_loop: for line in cmt.split_into_lines() {
|
line_loop: for line in cmt.split_into_lines() {
|
||||||
l := line.trim_left('\x01').trim_space()
|
l_normalized := line.trim_left('\x01')
|
||||||
|
l := l_normalized.trim_space()
|
||||||
last_ends_with_lb := comment.ends_with('\n')
|
last_ends_with_lb := comment.ends_with('\n')
|
||||||
if l == '' {
|
if l == '' {
|
||||||
comment += if last_ends_with_lb { '\n' } else { '\n\n' }
|
comment += if last_ends_with_lb { '\n' } else { '\n\n' }
|
||||||
@ -74,7 +76,7 @@ pub fn merge_doc_comments(comments []DocComment) string {
|
|||||||
}
|
}
|
||||||
has_codeblock_quote := l.starts_with('```')
|
has_codeblock_quote := l.starts_with('```')
|
||||||
if is_codeblock {
|
if is_codeblock {
|
||||||
comment += l + '\n'
|
comment += l_normalized.trim_string_left(trimmed_indent) + '\n'
|
||||||
if has_codeblock_quote {
|
if has_codeblock_quote {
|
||||||
is_codeblock = !is_codeblock
|
is_codeblock = !is_codeblock
|
||||||
}
|
}
|
||||||
@ -86,11 +88,14 @@ pub fn merge_doc_comments(comments []DocComment) string {
|
|||||||
}
|
}
|
||||||
comment += l + '\n'
|
comment += l + '\n'
|
||||||
is_codeblock = !is_codeblock
|
is_codeblock = !is_codeblock
|
||||||
|
trimmed_indent = l_normalized.all_before(l)
|
||||||
next_on_newline = true
|
next_on_newline = true
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
is_list := l.len > 1 && ((l[1] == ` ` && l[0] in [`-`, `*`, `+`])
|
||||||
|
|| (l.len > 2 && l[2] == ` ` && l[1] == `.` && l[0].is_digit()))
|
||||||
line_before_spaces := l.before(' ')
|
line_before_spaces := l.before(' ')
|
||||||
if (l.starts_with('|') && l.ends_with('|')) || l.starts_with('- ')
|
if is_list || (l.starts_with('|') && l.ends_with('|'))
|
||||||
|| (l.starts_with('#') && line_before_spaces.count('#') == line_before_spaces.len) {
|
|| (l.starts_with('#') && line_before_spaces.count('#') == line_before_spaces.len) {
|
||||||
comment += l + '\n'
|
comment += l + '\n'
|
||||||
next_on_newline = true
|
next_on_newline = true
|
||||||
|
Loading…
x
Reference in New Issue
Block a user