internal/core/export: extract docs from root

Change-Id: I0ddab86790c0447dbd8fab7e21dd37dd4e09c7b9 Reviewed-on: https://cue-review.googlesource.com/c/cue/+/9442 Reviewed-by: CUE cueckoo <cueckoo@gmail.com> Reviewed-by: Paul Jolly <paul@myitcv.org.uk>
cuelang · Apr 20, 2021 · 64ede63 · 64ede63
1 parent d5ff672
commit 64ede63
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 8 deletions.
diff --git a/internal/core/export/extract.go b/internal/core/export/extract.go
@@ -42,15 +42,22 @@ func extractDocs(v *adt.Vertex, a []adt.Conjunct) (docs []*ast.CommentGroup) {
 			docs = append(docs, extractDocs(v, v.Conjuncts)...)
 			continue
 		}
-		f, ok := x.Source().(*ast.Field)
-		if !ok || hasShorthandValue(f) {
-			continue
-		}
 
-		fields = append(fields, f)
-		for _, cg := range f.Comments() {
-			if !containsDoc(docs, cg) && cg.Doc {
-				docs = append(docs, cg)
+		switch f := x.Source().(type) {
+		case *ast.Field:
+			if hasShorthandValue(f) {
+				continue
+			}
+			fields = append(fields, f)
+			for _, cg := range f.Comments() {
+				if !containsDoc(docs, cg) && cg.Doc {
+					docs = append(docs, cg)
+				}
+			}
+
+		case *ast.File:
+			if c := internal.FileComment(f); c != nil {
+				docs = append(docs, c)
 			}
 		}
 	}

diff --git a/internal/core/export/testdata/docs.txtar b/internal/core/export/testdata/docs.txtar
@@ -47,6 +47,8 @@ baz: bar & {
 -- out.txt --
 -- out/doc --
 []
+- foobar defines at least foo.
+
 [Foo]
 - A Foo fooses stuff.