blob: e7e8d9553291051a7cace541203cae324631718e [file] [log] [blame]
<div class="Documentation-content js-docContent"> <section class="Documentation-overview">
<h3 tabindex="-1" id="pkg-overview" class="Documentation-overviewHeader">Overview <a href="#pkg-overview"></a></h3>
<div role="navigation" aria-label="Table of Contents">
<ul class="Documentation-toc"></ul>
</div><p>Package everydecl has every form of declaration known to dochtml.
It is designed to test that the generated HTML has the right id and data-kind
attributes.
</p>
</section><section class="Documentation-index">
<h3 id="pkg-index" class="Documentation-indexHeader">Index <a href="#pkg-index"></a></h3>
<ul class="Documentation-indexList">
<li class="Documentation-indexConstants"><a href="#pkg-constants">Constants</a></li>
<li class="Documentation-indexVariables"><a href="#pkg-variables">Variables</a></li>
<li class="Documentation-indexFunction">
<a href="#F">func F()</a></li>
<li class="Documentation-indexType"><a href="#A">type A</a></li>
<li class="Documentation-indexType"><a href="#B">type B</a></li>
<li class="Documentation-indexType"><a href="#I1">type I1</a></li>
<li class="Documentation-indexType"><a href="#I2">type I2</a></li>
<li class="Documentation-indexType"><a href="#S1">type S1</a></li>
<li class="Documentation-indexType"><a href="#S2">type S2</a></li>
<li class="Documentation-indexType"><a href="#T">type T</a></li>
<li><ul class="Documentation-indexTypeFunctions">
<li><a href="#TF">func TF() T</a></li>
</ul></li>
<li><ul class="Documentation-indexTypeMethods">
<li><a href="#T.M">func (T) M()</a></li>
</ul></li>
<li class="Documentation-indexNote"><a href="#pkg-note-BUG">Bugs</a></li></ul>
</section><h3 tabindex="-1" id="pkg-constants" class="Documentation-constantsHeader">Constants <a href="#pkg-constants"></a></h3>
<section class="Documentation-constants">
<div class="Documentation-declaration">
<span class="Documentation-declarationLink"><a class="Documentation-source" href="src">View Source</a></span>
<pre><span id="C" data-kind="constant">const C = 1</span></pre>
</div>
<div role="navigation" aria-label="Table of Contents">
<ul class="Documentation-toc"></ul>
</div><p>const
</p>
</section>
<h3 tabindex="-1" id="pkg-variables" class="Documentation-variablesHeader">Variables <a href="#pkg-variables"></a></h3>
<section class="Documentation-variables">
<div class="Documentation-declaration">
<span class="Documentation-declarationLink"><a class="Documentation-source" href="src">View Source</a></span>
<pre><span id="V" data-kind="variable">var V = 2</span></pre>
</div>
<div role="navigation" aria-label="Table of Contents">
<ul class="Documentation-toc"></ul>
</div><p>var
</p>
</section>
<h3 tabindex="-1" id="pkg-functions" class="Documentation-functionsHeader">Functions <a href="#pkg-functions"></a></h3>
<section class="Documentation-functions"><div class="Documentation-function">
<h4 tabindex="-1" id="F" data-kind="function" class="Documentation-functionHeader">
<span>func <a class="Documentation-source" href="src">F</a> <a class="Documentation-idLink" href="#F"></a></span>
<span class="Documentation-sinceVersion">
</span>
</h4>
<div class="Documentation-declaration">
<pre>func F()</pre>
</div>
<div role="navigation" aria-label="Table of Contents">
<ul class="Documentation-toc"></ul>
</div><p>func
</p>
</div></section>
<h3 tabindex="-1" id="pkg-types" class="Documentation-typesHeader">Types <a href="#pkg-types"></a></h3>
<section class="Documentation-types"><div class="Documentation-type">
<h4 tabindex="-1" id="A" data-kind="type" class="Documentation-typeHeader">
<span>type <a class="Documentation-source" href="src">A</a> <a class="Documentation-idLink" href="#A"></a></span>
<span class="Documentation-sinceVersion">
</span>
</h4>
<div class="Documentation-declaration">
<pre>type A <a href="/builtin#int">int</a></pre>
</div>
</div><div class="Documentation-type">
<h4 tabindex="-1" id="B" data-kind="type" class="Documentation-typeHeader">
<span>type <a class="Documentation-source" href="src">B</a> <a class="Documentation-idLink" href="#B"></a></span>
<span class="Documentation-sinceVersion">
</span>
</h4>
<div class="Documentation-declaration">
<pre>type B <a href="/builtin#bool">bool</a></pre>
</div>
</div><div class="Documentation-type">
<h4 tabindex="-1" id="I1" data-kind="type" class="Documentation-typeHeader">
<span>type <a class="Documentation-source" href="src">I1</a> <a class="Documentation-idLink" href="#I1"></a></span>
<span class="Documentation-sinceVersion">
</span>
</h4>
<div class="Documentation-declaration">
<pre>type I1 interface {
<span id="I1.M1" data-kind="method"> M1()
</span>}</pre>
</div>
</div><div class="Documentation-type">
<h4 tabindex="-1" id="I2" data-kind="type" class="Documentation-typeHeader">
<span>type <a class="Documentation-source" href="src">I2</a> <a class="Documentation-idLink" href="#I2"></a></span>
<span class="Documentation-sinceVersion">
</span>
</h4>
<div class="Documentation-declaration">
<pre>type I2 interface {
<a href="#I1">I1</a> <span class="comment">// embedded interface; should not have an id</span>
<span id="I2.M2" data-kind="method"> M2()
</span>}</pre>
</div>
</div><div class="Documentation-type">
<h4 tabindex="-1" id="S1" data-kind="type" class="Documentation-typeHeader">
<span>type <a class="Documentation-source" href="src">S1</a> <a class="Documentation-idLink" href="#S1"></a></span>
<span class="Documentation-sinceVersion">
</span>
</h4>
<div class="Documentation-declaration">
<pre>type S1 struct {
<span id="S1.F" data-kind="field"> F <a href="/builtin#int">int</a> <span class="comment">// field</span>
</span>}</pre>
</div>
</div><div class="Documentation-type">
<h4 tabindex="-1" id="S2" data-kind="type" class="Documentation-typeHeader">
<span>type <a class="Documentation-source" href="src">S2</a> <a class="Documentation-idLink" href="#S2"></a></span>
<span class="Documentation-sinceVersion">
</span>
</h4>
<div class="Documentation-declaration">
<pre>type S2 struct {
<span id="S2.S1" data-kind="field"> <a href="#S1">S1</a> <span class="comment">// embedded struct; should have an id</span>
</span><span id="S2.G" data-kind="field"> G <a href="/builtin#int">int</a>
</span>}</pre>
</div>
</div><div class="Documentation-type">
<h4 tabindex="-1" id="T" data-kind="type" class="Documentation-typeHeader">
<span>type <a class="Documentation-source" href="src">T</a> <a class="Documentation-idLink" href="#T"></a></span>
<span class="Documentation-sinceVersion">
</span>
</h4>
<div class="Documentation-declaration">
<pre>type T <a href="/builtin#int">int</a></pre>
</div>
<div role="navigation" aria-label="Table of Contents">
<ul class="Documentation-toc"></ul>
</div><p>type
</p>
<div class="Documentation-typeConstant">
<div class="Documentation-declaration">
<pre><span id="CT" data-kind="constant">const CT <a href="#T">T</a> = 3</span></pre>
</div>
<div role="navigation" aria-label="Table of Contents">
<ul class="Documentation-toc"></ul>
</div><p>typeConstant
</p>
</div><div class="Documentation-typeVariable">
<div class="Documentation-declaration">
<pre><span id="VT" data-kind="variable">var VT <a href="#T">T</a></span></pre>
</div>
<div role="navigation" aria-label="Table of Contents">
<ul class="Documentation-toc"></ul>
</div><p>typeVariable
</p>
</div><div class="Documentation-typeFunc">
<h4 tabindex="-1" id="TF" data-kind="function" class="Documentation-typeFuncHeader">
<span>func <a class="Documentation-source" href="src">TF</a> <a class="Documentation-idLink" href="#TF"></a></span>
<span class="Documentation-sinceVersion">
</span>
</h4>
<div class="Documentation-declaration">
<pre>func TF() <a href="#T">T</a></pre>
</div>
<div role="navigation" aria-label="Table of Contents">
<ul class="Documentation-toc"></ul>
</div><p>typeFunc
</p>
</div><div class="Documentation-typeMethod">
<h4 tabindex="-1" id="T.M" data-kind="method" class="Documentation-typeMethodHeader">
<span>func (T) <a class="Documentation-source" href="src">M</a> <a class="Documentation-idLink" href="#T.M"></a></span>
<span class="Documentation-sinceVersion">
</span>
</h4>
<div class="Documentation-declaration">
<pre>func (<a href="#T">T</a>) M()</pre>
</div>
<div role="navigation" aria-label="Table of Contents">
<ul class="Documentation-toc"></ul>
</div><p>method
BUG(uid): this verifies that notes are rendered
</p>
</div>
</div></section><h3 tabindex="-1" id="pkg-notes" class="Documentation-notesHeader">Notes <a href="#pkg-notes"></a></h3>
<section class="Documentation-notes"><div class="Documentation-note">
<h3 tabindex="-1" id="pkg-note-BUG" class="Documentation-noteHeader">Bugs <a href="#pkg-note-BUG"></a></h3>
<ul class="Documentation-noteList" style="padding-left: 20px; list-style: initial;">
<li style="margin: 6px 0 6px 0;"><div role="navigation" aria-label="Table of Contents">
<ul class="Documentation-toc"></ul>
</div><p>this verifies that notes are rendered
</p></li></ul>
</div></section></div>
----
<ul role="group" id="doc-outline">
<li role="none">
<a href="#pkg-overview" role="treeitem" aria-level="2" tabindex="-1"
data-gtmc="doc outline link">Overview</a>
</li>
<li class="DocNav-overview" role="none">
<a href="#pkg-index" role="treeitem" aria-level="2" tabindex="-1" aria-owns="nav-group-index"
data-gtmc="doc outline link">
Index
</a>
</li>
<li class="DocNav-constants" role="none">
<a href="#pkg-constants" role="treeitem" aria-level="2" tabindex="-1"
data-gtmc="doc outline link">
Constants
</a>
</li>
<li class="DocNav-variables" role="none">
<a href="#pkg-variables" role="treeitem" aria-level="2" tabindex="-1"
data-gtmc="doc outline link">
Variables
</a>
</li>
<li class="DocNav-functions" role="none">
<a href="#pkg-functions" role="treeitem" aria-level="2" tabindex="-1" aria-owns="nav-group-functions"
aria-expanded="false" data-gtmc="doc outline link">
Functions
</a>
<ul role="group" id="nav-group-functions">
<li role="none">
<a href="#F" role="treeitem" aria-level="3" tabindex="-1"
title="F()" data-gtmc="doc outline link">
F()
</a>
</li>
</ul>
</li>
<li class="DocNav-types" role="none">
<a href="#pkg-types" role="treeitem" aria-level="2" tabindex="-1" aria-owns="nav-group-types"
aria-expanded="false" data-gtmc="doc outline link">
Types
</a>
<ul role="group" id="nav-group-types">
<li role="none">
<a href="#A" role="treeitem" aria-level="3" tabindex="-1" title="type A"
data-gtmc="doc outline link">
type A
</a>
</li>
<li role="none">
<a href="#B" role="treeitem" aria-level="3" tabindex="-1" title="type B"
data-gtmc="doc outline link">
type B
</a>
</li>
<li role="none">
<a href="#I1" role="treeitem" aria-level="3" tabindex="-1" title="type I1"
data-gtmc="doc outline link">
type I1
</a>
</li>
<li role="none">
<a href="#I2" role="treeitem" aria-level="3" tabindex="-1" title="type I2"
data-gtmc="doc outline link">
type I2
</a>
</li>
<li role="none">
<a href="#S1" role="treeitem" aria-level="3" tabindex="-1" title="type S1"
data-gtmc="doc outline link">
type S1
</a>
</li>
<li role="none">
<a href="#S2" role="treeitem" aria-level="3" tabindex="-1" title="type S2"
data-gtmc="doc outline link">
type S2
</a>
</li>
<li role="none">
<a href="#T" role="treeitem" aria-expanded="false" aria-level="3" tabindex="-1"
data-aria-owns="nav.group.T" title="type T"
data-gtmc="doc outline link">
type T
</a>
<ul role="group" id="nav.group.T">
<li role="none">
<a href="#TF" role="treeitem" aria-level="4" tabindex="-1"
title="TF()" data-gtmc="doc outline link">
TF()
</a>
</li>
<li role="none">
<a href="#T.M" role="treeitem" aria-level="4" tabindex="-1"
title="M()" data-gtmc="doc outline link">
M()
</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="DocNav-notes" role="none">
<a href="#pkg-notes" role="treeitem" aria-expanded="false" aria-level="2" tabindex="-1"
aria-owns="nav-group-notes" data-gtmc="doc outline link">
Notes
</a>
<ul role="group" id="nav-group-notes">
<li role="none">
<a href="#pkg-note-BUG" role="treeitem" aria-level="3" tabindex="-1"
data-gtmc="doc outline link">
Bugs
</a>
</li>
</ul>
</li>
</ul>
----
<optgroup label="Documentation">
<option value="pkg-overview">Overview</option>
<option value="pkg-index">Index</option>
<option value="pkg-constants">Constants</option>
<option value="pkg-variables">Variables</option>
</optgroup>
<optgroup label="Functions">
<option value="F">F()</option>
</optgroup>
<optgroup label="Types">
<option value="A">type A</option>
<option value="B">type B</option>
<option value="I1">type I1</option>
<option value="I2">type I2</option>
<option value="S1">type S1</option>
<option value="S2">type S2</option>
<option value="T">type T</option>
<option value="TF">TF()</option>
<option value="T.M">M()</option>
</optgroup>
<optgroup label="Notes">
<option value="pkg-note-BUG">Bugs</option>
</optgroup>