mirror of https://github.com/golang/go.git
doc/go1.14: mention go/doc.NewFromFiles and associated new data fields
Updates #23864 Updates #36878 Change-Id: I6efdaafbe5207c625643f201a5931ad735941365 Reviewed-on: https://go-review.googlesource.com/c/go/+/217125 Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
This commit is contained in:
parent
25d0ffe603
commit
817c5c4517
|
|
@ -482,6 +482,26 @@ TODO
|
||||||
|
|
||||||
</dl><!-- encoding/json -->
|
</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>
|
<dl id="mime"><dt><a href="/pkg/mime/">mime</a></dt>
|
||||||
<dd>
|
<dd>
|
||||||
<p><!-- CL 186927 -->
|
<p><!-- CL 186927 -->
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue