aboutsummaryrefslogtreecommitdiff
path: root/lib/godoc/package.html
blob: 0bc017379c639f36989cf745d8887a1c99401cbd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<!--
	Copyright 2009 The Go Authors. All rights reserved.
	Use of this source code is governed by a BSD-style
	license that can be found in the LICENSE file.
-->
{{with .PAst}}
	<pre>{{node_html . $.FSet}}</pre>
{{end}}
{{with .PDoc}}
	<!-- PackageName is printed as title by the top-level template -->
	{{if $.IsPkg}}
		<p><code>import "{{html .ImportPath}}"</code></p>
	{{end}}
	{{comment_html .Doc}}
	{{if $.IsPkg}}
		{{with .Filenames}}
			<p>
			<h4>Package files</h4>
			<span style="font-size:90%">
			{{range .}}
				<a href="/{{.|srcLink}}">{{.|filename|html}}</a>
			{{end}}
			</span>
			</p>
		{{end}}
	{{end}}
	{{with .Consts}}
		<h2 id="Constants">Constants</h2>
		{{range .}}
			{{comment_html .Doc}}
			<pre>{{node_html .Decl $.FSet}}</pre>
		{{end}}
	{{end}}
	{{with .Vars}}
		<h2 id="Variables">Variables</h2>
		{{range .}}
			{{comment_html .Doc}}
			<pre>{{node_html .Decl $.FSet}}</pre>
		{{end}}
	{{end}}
	{{with .Funcs}}
		{{range .}}
			{{/* Name is a string - no need for FSet */}}
			{{$name := html .Name}}
			<h2 id="{{$name}}">func <a href="/{{posLink_url .Decl $.FSet}}">{{$name}}</a></h2>
			<p><code>{{node_html .Decl $.FSet}}</code></p>
			{{comment_html .Doc}}
		{{end}}
	{{end}}
	{{with .Types}}
		{{range .}}
			{{$tname := node_html .Type.Name $.FSet}}
			<h2 id="{{$tname}}">type <a href="/{{posLink_url .Decl $.FSet}}">{{$tname}}</a></h2>
			{{comment_html .Doc}}
			<p><pre>{{node_html .Decl $.FSet}}</pre></p>
			{{range .Consts}}
				{{comment_html .Doc}}
				<pre>{{node_html .Decl $.FSet}}</pre>
			{{end}}
			{{range .Vars}}
				{{comment_html .Doc}}
				<pre>{{node_html .Decl $.FSet}}</pre>
			{{end}}
			{{range .Factories}}
				{{$name := html .Name}}
				<h3 id="{{$tname}}.{{$name}}">func <a href="/{{posLink_url .Decl $.FSet}}">{{$name}}</a></h3>
				<p><code>{{node_html .Decl $.FSet}}</code></p>
				{{comment_html .Doc}}
			{{end}}
			{{range .Methods}}
				{{$name := html .Name}}
				<h3 id="{{$tname}}.{{$name}}">func ({{node_html .Recv $.FSet}}) <a href="/{{posLink_url .Decl $.FSet}}">{{$name}}</a></h3>
				<p><code>{{node_html .Decl $.FSet}}</code></p>
				{{comment_html .Doc}}
			{{end}}
		{{end}}
	{{end}}
	{{with .Bugs}}
		<h2 id="Bugs">Bugs</h2>
		{{range .}}
		{{comment_html .}}
		{{end}}
	{{end}}
{{end}}
{{with .PList}}
	<h2>Other packages</h2>
	<p>
	{{/* PList entries are strings - no need for FSet */}}
	{{range .}}
	<a href="?p={{urlquery .}}">{{html .}}</a><br />
	{{end}}
	</p>
{{end}}
{{with .Dirs}}
	<p class="detail">
	Need more packages? The
	<a href="http://godashboard.appspot.com/package">Package Dashboard</a>
	provides a list of <a href="/cmd/goinstall/">goinstallable</a> packages.
	</p>
	{{/* DirList entries are numbers and strings - no need for FSet */}}
	<h2 id="Subdirectories">Subdirectories</h2>
	<p>
	<table class="layout">
	<tr>
	<th align="left" colspan="{{html .MaxHeight}}">Name</th>
	<td width="25">&nbsp;</td>
	<th align="left">Synopsis</th>
	</tr>
	<tr>
	<th align="left"><a href="..">..</a></th>
	</tr>
	{{range .List}}
		<tr>
		{{repeat `<td width="25"></td>` .Depth}}
		<td align="left" colspan="{{html .Height}}"><a href="{{html .Path}}">{{html .Name}}</a></td>
		<td></td>
		<td align="left">{{html .Synopsis}}</td>
		</tr>
	{{end}}
	</table>
	</p>
{{end}}