]> Cypherpunks repositories - gostls13.git/commitdiff
doc/go1.14: mention go/doc.NewFromFiles and associated new data fields
authorIan Lance Taylor <iant@golang.org>
Fri, 31 Jan 2020 01:06:31 +0000 (17:06 -0800)
committerIan Lance Taylor <iant@golang.org>
Fri, 31 Jan 2020 02:45:04 +0000 (02:45 +0000)
Updates #23864
Updates #36878

Change-Id: I6efdaafbe5207c625643f201a5931ad735941365
Reviewed-on: https://go-review.googlesource.com/c/go/+/217125
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
doc/go1.14.html

index 1f13f227b3434f68f8635400bc99e58143b29ea7..949b3d93830ac5cdd54293f59a579960a4b6a107 100644 (file)
@@ -482,6 +482,26 @@ TODO
 
 </dl><!-- encoding/json -->
 
+<dl id="go/doc"><dt><a href="/go/doc/">go/doc</a></dt>
+  <dd>
+    <p><!-- CL 204830 -->
+      The new
+      function <a href="/pkg/go/doc/#NewFromFiles"><code>NewFromFiles</code></a>
+      computes package documentation from a list
+      of <code>*ast.File</code>'s and associates examples with the
+      appropriate package elements.
+      The new information is available in a new <code>Examples</code>
+      field
+      in the <a href="/pkg/go/doc/#Package"><code>Package</code></a>, <a href="/pkg/go/doc/#Type"><code>Type</code></a>,
+      and <a href="/pkg/go/doc/#Func"><code>Func</code></a> types, and a
+      new <a href="/pkg/go/doc/#Example.Suffix"><code>Suffix</code></a>
+      field in
+      the <a href="/pkg/go/doc/#Example"><code>Example</code></a>
+      type.
+    </p>
+  </dd>
+</dl><!-- go/doc -->
+
 <dl id="mime"><dt><a href="/pkg/mime/">mime</a></dt>
   <dd>
     <p><!-- CL 186927 -->