package_default.html 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  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. {{if $.IsMain}}
  18. {{/* command documentation */}}
  19. {{comment_html .Doc}}
  20. {{else}}
  21. {{/* package documentation */}}
  22. <div id="short-nav">
  23. <dl>
  24. <dd><code>import "github.com/aws/aws-sdk-go/{{html .ImportPath}}"</code></dd>
  25. </dl>
  26. <dl>
  27. <dd><a href="#pkg-overview" class="overviewLink">Overview</a></dd>
  28. <dd><a href="#pkg-index" class="indexLink">Index</a></dd>
  29. {{if $.Examples}}
  30. <dd><a href="#pkg-examples" class="examplesLink">Examples</a></dd>
  31. {{end}}
  32. </dl>
  33. </div>
  34. <!-- The package's Name is printed as title by the top-level template -->
  35. <div id="pkg-overview" class="toggleVisible">
  36. <div class="collapsed">
  37. <h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
  38. </div>
  39. <div class="expanded">
  40. <h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
  41. {{comment_html .Doc}}
  42. </div>
  43. </div>
  44. {{example_html $ ""}}
  45. <div id="pkg-index" class="toggleVisible">
  46. <div class="collapsed">
  47. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  48. </div>
  49. <div class="expanded">
  50. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  51. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  52. <div id="manual-nav">
  53. <dl>
  54. {{if .Consts}}
  55. <dd><a href="#pkg-constants">Constants</a></dd>
  56. {{end}}
  57. {{if .Vars}}
  58. <dd><a href="#pkg-variables">Variables</a></dd>
  59. {{end}}
  60. {{range .Funcs}}
  61. {{$name_html := html .Name}}
  62. <dd><a href="#{{$name_html}}">{{node_html $ .Decl false | sanitize}}</a></dd>
  63. {{end}}
  64. {{range .Types}}
  65. {{$tname_html := html .Name}}
  66. <dd><a href="#{{$tname_html}}">type {{$tname_html}}</a></dd>
  67. {{range .Funcs}}
  68. {{$name_html := html .Name}}
  69. <dd>&nbsp; &nbsp; <a href="#{{$name_html}}">{{node_html $ .Decl false | sanitize}}</a></dd>
  70. {{end}}
  71. {{range .Methods}}
  72. {{$name_html := html .Name}}
  73. <dd>&nbsp; &nbsp; <a href="#{{$tname_html}}.{{$name_html}}">{{node_html $ .Decl false | sanitize}}</a></dd>
  74. {{end}}
  75. {{end}}
  76. {{if $.Notes}}
  77. {{range $marker, $item := $.Notes}}
  78. <dd><a href="#pkg-note-{{$marker}}">{{noteTitle $marker | html}}s</a></dd>
  79. {{end}}
  80. {{end}}
  81. </dl>
  82. </div><!-- #manual-nav -->
  83. {{if $.Examples}}
  84. <div id="pkg-examples">
  85. <h4>Examples</h4>
  86. <dl>
  87. {{range $.Examples}}
  88. <dd><a class="exampleLink" href="#example_{{.Name}}">{{example_name .Name}}</a></dd>
  89. {{end}}
  90. </dl>
  91. </div>
  92. {{end}}
  93. {{with .Filenames}}
  94. <h4>Package files</h4>
  95. <p>
  96. <span style="font-size:90%">
  97. {{range .}}
  98. <a href="{{.|githubFileLink|html}}">{{.|filename|html}}</a>
  99. {{end}}
  100. </span>
  101. </p>
  102. {{end}}
  103. </div><!-- .expanded -->
  104. </div><!-- #pkg-index -->
  105. <div id="pkg-callgraph" class="toggle" style="display: none">
  106. <div class="collapsed">
  107. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  108. </div> <!-- .expanded -->
  109. <div class="expanded">
  110. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  111. <p>
  112. In the call graph viewer below, each node
  113. is a function belonging to this package
  114. and its children are the functions it
  115. calls&mdash;perhaps dynamically.
  116. </p>
  117. <p>
  118. The root nodes are the entry points of the
  119. package: functions that may be called from
  120. outside the package.
  121. There may be non-exported or anonymous
  122. functions among them if they are called
  123. dynamically from another package.
  124. </p>
  125. <p>
  126. Click a node to visit that function's source code.
  127. From there you can visit its callers by
  128. clicking its declaring <code>func</code>
  129. token.
  130. </p>
  131. <p>
  132. Functions may be omitted if they were
  133. determined to be unreachable in the
  134. particular programs or tests that were
  135. analyzed.
  136. </p>
  137. <!-- Zero means show all package entry points. -->
  138. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  139. </div>
  140. </div> <!-- #pkg-callgraph -->
  141. {{with .Consts}}
  142. <h2 id="pkg-constants">Constants</h2>
  143. {{range .}}
  144. <pre>{{node_html $ .Decl true}}</pre>
  145. {{comment_html .Doc}}
  146. {{end}}
  147. {{end}}
  148. {{with .Vars}}
  149. <h2 id="pkg-variables">Variables</h2>
  150. {{range .}}
  151. <pre>{{node_html $ .Decl true}}</pre>
  152. {{comment_html .Doc}}
  153. {{end}}
  154. {{end}}
  155. {{range .Funcs}}
  156. {{/* Name is a string - no need for FSet */}}
  157. {{$name_html := html .Name}}
  158. <h2 id="{{$name_html}}">func <a href="{{posLink_url $ .Decl}}">{{$name_html}}</a></h2>
  159. <pre>{{node_html $ .Decl true}}</pre>
  160. {{comment_html .Doc}}
  161. {{example_html $ .Name}}
  162. {{callgraph_html $ "" .Name}}
  163. {{end}}
  164. {{range .Types}}
  165. {{$tname := .Name}}
  166. {{$tname_html := html .Name}}
  167. <h2 id="{{$tname_html}}">type <a href="{{posLink_url $ .Decl}}">{{$tname_html}}</a></h2>
  168. <pre>{{node_html $ .Decl true}}</pre>
  169. {{comment_html .Doc}}
  170. {{range .Consts}}
  171. <pre>{{node_html $ .Decl true}}</pre>
  172. {{comment_html .Doc}}
  173. {{end}}
  174. {{range .Vars}}
  175. <pre>{{node_html $ .Decl true}}</pre>
  176. {{comment_html .Doc}}
  177. {{end}}
  178. {{example_html $ $tname}}
  179. {{implements_html $ $tname}}
  180. {{methodset_html $ $tname}}
  181. {{range .Funcs}}
  182. {{$name_html := html .Name}}
  183. <h3 id="{{$name_html}}">func <a href="{{posLink_url $ .Decl}}">{{$name_html}}</a></h3>
  184. <pre>{{node_html $ .Decl true}}</pre>
  185. {{comment_html .Doc}}
  186. {{example_html $ .Name}}
  187. {{callgraph_html $ "" .Name}}
  188. {{end}}
  189. {{range .Methods}}
  190. {{$name_html := html .Name}}
  191. <h3 id="{{$tname_html}}.{{$name_html}}">func ({{html .Recv}}) <a href="{{posLink_url $ .Decl}}">{{$name_html}}</a></h3>
  192. <pre>{{node_html $ .Decl true}}</pre>
  193. {{comment_html .Doc}}
  194. {{$name := printf "%s_%s" $tname .Name}}
  195. {{example_html $ $name}}
  196. {{callgraph_html $ .Recv .Name}}
  197. {{end}}
  198. {{end}}
  199. {{end}}
  200. {{with $.Notes}}
  201. {{range $marker, $content := .}}
  202. <h2 id="pkg-note-{{$marker}}">{{noteTitle $marker | html}}s</h2>
  203. <ul style="list-style: none; padding: 0;">
  204. {{range .}}
  205. <li><a href="{{posLink_url $ .}}">&#x261e;</a> {{html .Body}}</li>
  206. {{end}}
  207. </ul>
  208. {{end}}
  209. {{end}}
  210. {{end}}
  211. {{with .PAst}}
  212. {{range $filename, $ast := .}}
  213. <a href="{{$filename|srcLink|html}}">{{$filename|filename|html}}</a>:<pre>{{node_html $ $ast false}}</pre>
  214. {{end}}
  215. {{end}}
  216. {{with .Dirs}}
  217. {{if eq $.Dirname "/src"}}
  218. <div id="manual-nav">
  219. <dl>
  220. <dt><a href="#stdlib">Standard library</a></dt>
  221. <dt><a href="#other">Other packages</a></dt>
  222. <dd><a href="#subrepo">Sub-repositories</a></dd>
  223. <dd><a href="#community">Community</a></dd>
  224. </dl>
  225. </div>
  226. <h2 id="stdlib">Standard library</h2>
  227. {{end}}
  228. {{end}}