github.com/jgarto/itcv@v0.0.0-20180826224514-4eea09c1aa0d/_vendor/src/golang.org/x/tools/godoc/static/package.html (about) 1 <!-- 2 Copyright 2009 The Go Authors. All rights reserved. 3 Use of this source code is governed by a BSD-style 4 license that can be found in the LICENSE file. 5 --> 6 <!-- 7 Note: Static (i.e., not template-generated) href and id 8 attributes start with "pkg-" to make it impossible for 9 them to conflict with generated attributes (some of which 10 correspond to Go identifiers). 11 --> 12 {{with .PDoc}} 13 <script type='text/javascript'> 14 document.ANALYSIS_DATA = {{$.AnalysisData}}; 15 document.CALLGRAPH = {{$.CallGraph}}; 16 </script> 17 18 {{if $.IsMain}} 19 {{/* command documentation */}} 20 {{comment_html .Doc}} 21 {{else}} 22 {{/* package documentation */}} 23 <div id="short-nav"> 24 <dl> 25 <dd><code>import "{{html .ImportPath}}"</code></dd> 26 </dl> 27 <dl> 28 <dd><a href="#pkg-overview" class="overviewLink">Overview</a></dd> 29 <dd><a href="#pkg-index" class="indexLink">Index</a></dd> 30 {{if $.Examples}} 31 <dd><a href="#pkg-examples" class="examplesLink">Examples</a></dd> 32 {{end}} 33 {{if $.Dirs}} 34 <dd><a href="#pkg-subdirectories">Subdirectories</a></dd> 35 {{end}} 36 </dl> 37 </div> 38 <!-- The package's Name is printed as title by the top-level template --> 39 <div id="pkg-overview" class="toggleVisible"> 40 <div class="collapsed"> 41 <h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2> 42 </div> 43 <div class="expanded"> 44 <h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2> 45 {{comment_html .Doc}} 46 {{example_html $ ""}} 47 </div> 48 </div> 49 50 <div id="pkg-index" class="toggleVisible"> 51 <div class="collapsed"> 52 <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2> 53 </div> 54 <div class="expanded"> 55 <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2> 56 57 <!-- Table of contents for API; must be named manual-nav to turn off auto nav. --> 58 <div id="manual-nav"> 59 <dl> 60 {{if .Consts}} 61 <dd><a href="#pkg-constants">Constants</a></dd> 62 {{end}} 63 {{if .Vars}} 64 <dd><a href="#pkg-variables">Variables</a></dd> 65 {{end}} 66 {{range .Funcs}} 67 {{$name_html := html .Name}} 68 <dd><a href="#{{$name_html}}">{{node_html $ .Decl false | sanitize}}</a></dd> 69 {{end}} 70 {{range .Types}} 71 {{$tname_html := html .Name}} 72 <dd><a href="#{{$tname_html}}">type {{$tname_html}}</a></dd> 73 {{range .Funcs}} 74 {{$name_html := html .Name}} 75 <dd> <a href="#{{$name_html}}">{{node_html $ .Decl false | sanitize}}</a></dd> 76 {{end}} 77 {{range .Methods}} 78 {{$name_html := html .Name}} 79 <dd> <a href="#{{$tname_html}}.{{$name_html}}">{{node_html $ .Decl false | sanitize}}</a></dd> 80 {{end}} 81 {{end}} 82 {{if $.Notes}} 83 {{range $marker, $item := $.Notes}} 84 <dd><a href="#pkg-note-{{$marker}}">{{noteTitle $marker | html}}s</a></dd> 85 {{end}} 86 {{end}} 87 </dl> 88 </div><!-- #manual-nav --> 89 90 {{if $.Examples}} 91 <div id="pkg-examples"> 92 <h3>Examples</h3> 93 <dl> 94 {{range $.Examples}} 95 <dd><a class="exampleLink" href="#example_{{.Name}}">{{example_name .Name}}</a></dd> 96 {{end}} 97 </dl> 98 </div> 99 {{end}} 100 101 {{with .Filenames}} 102 <h3>Package files</h3> 103 <p> 104 <span style="font-size:90%"> 105 {{range .}} 106 <a href="{{.|srcLink|html}}">{{.|filename|html}}</a> 107 {{end}} 108 </span> 109 </p> 110 {{end}} 111 </div><!-- .expanded --> 112 </div><!-- #pkg-index --> 113 114 <div id="pkg-callgraph" class="toggle" style="display: none"> 115 <div class="collapsed"> 116 <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2> 117 </div> <!-- .expanded --> 118 <div class="expanded"> 119 <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2> 120 <p> 121 In the call graph viewer below, each node 122 is a function belonging to this package 123 and its children are the functions it 124 calls—perhaps dynamically. 125 </p> 126 <p> 127 The root nodes are the entry points of the 128 package: functions that may be called from 129 outside the package. 130 There may be non-exported or anonymous 131 functions among them if they are called 132 dynamically from another package. 133 </p> 134 <p> 135 Click a node to visit that function's source code. 136 From there you can visit its callers by 137 clicking its declaring <code>func</code> 138 token. 139 </p> 140 <p> 141 Functions may be omitted if they were 142 determined to be unreachable in the 143 particular programs or tests that were 144 analyzed. 145 </p> 146 <!-- Zero means show all package entry points. --> 147 <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul> 148 </div> 149 </div> <!-- #pkg-callgraph --> 150 151 {{with .Consts}} 152 <h2 id="pkg-constants">Constants</h2> 153 {{range .}} 154 {{comment_html .Doc}} 155 <pre>{{node_html $ .Decl true}}</pre> 156 {{end}} 157 {{end}} 158 {{with .Vars}} 159 <h2 id="pkg-variables">Variables</h2> 160 {{range .}} 161 {{comment_html .Doc}} 162 <pre>{{node_html $ .Decl true}}</pre> 163 {{end}} 164 {{end}} 165 {{range .Funcs}} 166 {{/* Name is a string - no need for FSet */}} 167 {{$name_html := html .Name}} 168 <h2 id="{{$name_html}}">func <a href="{{posLink_url $ .Decl}}">{{$name_html}}</a> 169 <a class="permalink" href="#{{$name_html}}">¶</a> 170 </h2> 171 <pre>{{node_html $ .Decl true}}</pre> 172 {{comment_html .Doc}} 173 {{example_html $ .Name}} 174 {{callgraph_html $ "" .Name}} 175 176 {{end}} 177 {{range .Types}} 178 {{$tname := .Name}} 179 {{$tname_html := html .Name}} 180 <h2 id="{{$tname_html}}">type <a href="{{posLink_url $ .Decl}}">{{$tname_html}}</a> 181 <a class="permalink" href="#{{$tname_html}}">¶</a> 182 </h2> 183 {{comment_html .Doc}} 184 <pre>{{node_html $ .Decl true}}</pre> 185 186 {{range .Consts}} 187 {{comment_html .Doc}} 188 <pre>{{node_html $ .Decl true}}</pre> 189 {{end}} 190 191 {{range .Vars}} 192 {{comment_html .Doc}} 193 <pre>{{node_html $ .Decl true}}</pre> 194 {{end}} 195 196 {{example_html $ $tname}} 197 {{implements_html $ $tname}} 198 {{methodset_html $ $tname}} 199 200 {{range .Funcs}} 201 {{$name_html := html .Name}} 202 <h3 id="{{$name_html}}">func <a href="{{posLink_url $ .Decl}}">{{$name_html}}</a> 203 <a class="permalink" href="#{{$name_html}}">¶</a> 204 </h3> 205 <pre>{{node_html $ .Decl true}}</pre> 206 {{comment_html .Doc}} 207 {{example_html $ .Name}} 208 {{callgraph_html $ "" .Name}} 209 {{end}} 210 211 {{range .Methods}} 212 {{$name_html := html .Name}} 213 <h3 id="{{$tname_html}}.{{$name_html}}">func ({{html .Recv}}) <a href="{{posLink_url $ .Decl}}">{{$name_html}}</a> 214 <a class="permalink" href="#{{$tname_html}}.{{$name_html}}">¶</a> 215 </h3> 216 <pre>{{node_html $ .Decl true}}</pre> 217 {{comment_html .Doc}} 218 {{$name := printf "%s_%s" $tname .Name}} 219 {{example_html $ $name}} 220 {{callgraph_html $ .Recv .Name}} 221 {{end}} 222 {{end}} 223 {{end}} 224 225 {{with $.Notes}} 226 {{range $marker, $content := .}} 227 <h2 id="pkg-note-{{$marker}}">{{noteTitle $marker | html}}s</h2> 228 <ul style="list-style: none; padding: 0;"> 229 {{range .}} 230 <li><a href="{{posLink_url $ .}}" style="float: left;">☞</a> {{comment_html .Body}}</li> 231 {{end}} 232 </ul> 233 {{end}} 234 {{end}} 235 {{end}} 236 237 {{with .PAst}} 238 {{range $filename, $ast := .}} 239 <a href="{{$filename|srcLink|html}}">{{$filename|filename|html}}</a>:<pre>{{node_html $ $ast false}}</pre> 240 {{end}} 241 {{end}} 242 243 {{with .Dirs}} 244 {{/* DirList entries are numbers and strings - no need for FSet */}} 245 {{if $.PDoc}} 246 <h2 id="pkg-subdirectories">Subdirectories</h2> 247 {{end}} 248 <div class="pkg-dir"> 249 <table> 250 <tr> 251 <th class="pkg-name">Name</th> 252 <th class="pkg-synopsis">Synopsis</th> 253 </tr> 254 255 {{if not ((eq $.Dirname "/src/cmd") $.DirFlat)}} 256 <tr> 257 <td colspan="2"><a href="..">..</a></td> 258 </tr> 259 {{end}} 260 261 {{range .List}} 262 <tr> 263 {{if $.DirFlat}} 264 {{if .HasPkg}} 265 <td class="pkg-name"> 266 <a href="{{html .Path}}/{{modeQueryString $.Mode | html}}">{{html .Path}}</a> 267 </td> 268 {{end}} 269 {{else}} 270 <td class="pkg-name" style="padding-left: {{multiply .Depth 20}}px;"> 271 <a href="{{html .Path}}/{{modeQueryString $.Mode | html}}">{{html .Name}}</a> 272 </td> 273 {{end}} 274 <td class="pkg-synopsis"> 275 {{html .Synopsis}} 276 </td> 277 </tr> 278 {{end}} 279 </table> 280 </div> 281 {{end}}