parser: add documentation support in ast.VlsInfo (#25503)

Author: kbkpbot

vlib/v/ast/table.v

@@ -88,7 +88,7 @@ pub mut:
 	gostmts            int    // how many `go` statements there were in the parsed files.
 	// When table.gostmts > 0, __VTHREADS__ is defined, which can be checked with `$if threads {`
 	enum_decls        map[string]EnumDecl
-	vls_info          map[string]VLSInfo
+	vls_info          map[string]VlsInfo
 	module_deprecated map[string]bool
 	module_attrs      map[string][]Attr // module attributes
 	builtin_pub_fns   map[string]bool
@@ -113,12 +113,10 @@ pub mut:
 	c_str string
 }
 
-pub struct VLSInfo {
+pub struct VlsInfo {
 pub mut:
-	pos          token.Pos
-	pre_comments []Comment
-	comments     []Comment
-	end_comments []Comment
+	pos token.Pos
+	doc string // documentation
 }
 
 // used by vls to avoid leaks
@@ -2777,6 +2775,6 @@ pub fn (mut t Table) get_veb_result_type_idx() int {
 }
 
 @[inline]
-pub fn (mut t Table) register_vls_info(key string, val VLSInfo) {
+pub fn (mut t Table) register_vls_info(key string, val VlsInfo) {
 	t.vls_info[key] = val
 }

vlib/v/parser/enum.v

@@ -48,6 +48,11 @@ fn (mut p Parser) enum_decl() ast.EnumDecl {
 	}
 	p.check(.key_enum)
 	end_pos := p.tok.pos()
+	mut comments_before_key_enum := if p.is_vls {
+		p.cur_comments.clone()
+	} else {
+		[]
+	}
 	if p.disallow_declarations_in_script_mode() {
 		return ast.EnumDecl{}
 	}
@@ -253,20 +258,39 @@ fn (mut p Parser) enum_decl() ast.EnumDecl {
 
 	if !already_exists {
 		p.table.register_enum_decl(enum_decl)
-		if p.pref.is_vls {
+		if p.is_vls {
 			key := 'enum_${name}'
-			val := ast.VLSInfo{
-				pos:      typ_pos
-				comments: enum_decl_comments
+			mut has_decl_end_comment := false
+			if enum_decl.comments.len > 0
+				&& enum_decl.comments[0].pos.line_nr == enum_decl.pos.line_nr {
+				// enum MyEnum { // MyEnum end_comment1
+				comments_before_key_enum << enum_decl.comments[0]
+				has_decl_end_comment = true
+			}
+			val := ast.VlsInfo{
+				pos: typ_pos
+				doc: p.keyword_comments_to_string(enum_name, comments_before_key_enum)
 			}
 			p.table.register_vls_info(key, val)
-			for f in fields {
+			for i, f in fields {
 				f_key := 'enum_${name}.${f.name}'
-				f_val := ast.VLSInfo{
-					pos:          f.pos
-					pre_comments: f.pre_comments
-					comments:     f.comments
-					end_comments: f.next_comments
+				f_val := if i == 0 {
+					first_field_pre_comment := if has_decl_end_comment {
+						enum_decl.comments[1..].clone()
+					} else {
+						enum_decl.comments
+					}
+					ast.VlsInfo{
+						pos: f.pos
+						doc: p.comments_to_string(first_field_pre_comment) +
+							p.comments_to_string(f.comments)
+					}
+				} else {
+					ast.VlsInfo{
+						pos: f.pos
+						doc: p.comments_to_string(fields[i - 1].next_comments) +
+							p.comments_to_string(f.comments)
+					}
 				}
 				p.table.register_vls_info(f_key, f_val)
 			}

vlib/v/parser/fn.v

@@ -301,6 +301,11 @@ fn (mut p Parser) fn_decl() ast.FnDecl {
 		p.next()
 	}
 	p.check(.key_fn)
+	mut comments_before_key_fn := if p.is_vls {
+		p.cur_comments.clone()
+	} else {
+		[]
+	}
 	comments << p.eat_comments()
 	p.open_scope()
 	defer {
@@ -753,16 +758,17 @@ run them via `v file.v` instead',
 		p.table.register_fn_generic_types(fn_decl.fkey())
 	}
 	p.label_names = []
-	if p.pref.is_vls {
+	if p.is_vls {
 		type_str := if (is_method || is_static_type_method) && rec.typ != ast.no_type {
 			p.table.sym(rec.typ.idx_type()).name.all_after_last('.')
 		} else {
 			''
 		}
 		key := 'fn_${p.mod}[${type_str}]${short_fn_name}'
-		val := ast.VLSInfo{
-			pos:      fn_decl.pos
-			comments: fn_decl.comments // TODO: we need comment just before fn decl
+		val := ast.VlsInfo{
+			pos: fn_decl.pos
+			doc: p.keyword_comments_to_string(short_fn_name, comments_before_key_fn) +
+				p.comments_to_string(fn_decl.end_comments)
 		}
 		p.table.register_vls_info(key, val)
 	}