1
0
mirror of https://github.com/golang/go synced 2024-11-14 23:20:27 -07:00
Commit Graph

146 Commits

Author SHA1 Message Date
Russ Cox
1c6c0eee20 godoc: skip template wrapping for complete HTML files
demo at http://wreck:8080/doc/
click on go_talk-20100112.html

R=gri
CC=golang-dev
https://golang.org/cl/186137
2010-01-13 13:09:33 -08:00
Russ Cox
c918c41c58 add doc/devel/index.html, linked from nav bar
R=r
CC=golang-dev
https://golang.org/cl/181156
2010-01-07 18:23:41 -08:00
Russ Cox
d55abfd2c9 doc: split contribute.html into code.html and contribute.html
R=r
https://golang.org/cl/170042
2009-12-09 14:05:12 -08:00
Robert Griesemer
9e450880e9 some godoc cleanup:
- simplified dealing with parse errors: no need to intersperse them in the source
- improve visibility of highlighted identifiers by showing them in bold

R=rsc
https://golang.org/cl/163051
2009-12-01 09:15:05 -08:00
Robert Griesemer
af872b2ba4 Add id attribute to h2 and h3 tags so that they exist when referring
to generated pages even if Javascript has not introduced them yet.

R=rsc
https://golang.org/cl/154167
2009-11-16 15:25:16 -08:00
Russ Cox
c8bb81fddc video is ready
R=r
http://codereview.prom.corp.google.com/1024050
2009-11-10 17:05:07 -08:00
Russ Cox
8a902ed840 video is coming soon
R=r
http://go/go-review/1024049
2009-11-10 14:47:23 -08:00
Russ Cox
78c47c36b2 update video links
R=r
http://go/go-review/1024048
2009-11-10 14:09:01 -08:00
Russ Cox
4414442442 remove internal references from doc/install.html
and doc/contribute.html.

add #go-nuts to help section on nav bar.

R=r
http://go/go-review/1025035
2009-11-10 09:37:03 -08:00
Robert Griesemer
a10e2051ae - add .. link to package directory listing, for easy traversal
- matches style of source file directory listing

R=rsc
http://go/go-review/1024044
2009-11-09 23:22:04 -08:00
Robert Griesemer
c110269579 cleanup style:
- consistently remove all underbars from links
- this removes need for noline style
- removed unused info style

R=r, rsc
http://go/go-review/1025032
2009-11-09 16:19:38 -08:00
Robert Griesemer
93c3f5124e make search box ever so slightly wider
R=rsc
http://go/go-review/1024036
2009-11-09 14:49:01 -08:00
Robert Griesemer
568c018fee make search box width dynamically sized
R=rsc, agl
http://go/go-review/1024032
2009-11-09 10:27:07 -08:00
Robert Griesemer
d731dc8e72 Addressing issue brought up by dsymonds:
- When providing alternative spellings to a query, do not
  prefix it with a package qualifier as the suggestion may
  not have any results. Correctly filtering is quite a bit
  of work, and clicking the alternative spelling will always
  also show the qualified hits if they exist (but also others).
  Seems good enough for now.
- Give user feedback when the query syntax was wrong.
- Package names in search results are now links to the respective
  package documentation.
- Experimented with excluding main packages and test files
  from index with inconclusive results. Code is present and
  can be enabled by changing a flag in the source. This needs
  some more work.

R=rsc
CC=r, dsymonds
http://go/go-review/1026033
2009-11-08 23:34:08 -08:00
Robert Griesemer
7837dbfcb8 use grouping instead of colors to show non-global search hits:
- introduced a new run per file containing all spots belonging
  to the same kind (e.g. var decl, const decl, etc.)
- more comments, better index.go file organization

R=rsc
http://go/go-review/1026028
2009-11-08 20:17:04 -08:00
Robert Griesemer
202ede1240 - properly align package synopses
(this was surprisingly hard to get right in HTML)
- show modification times in source directory listings
- various tweaks

R=rsc
http://go/go-review/1024024
2009-11-08 16:47:32 -08:00
Russ Cox
826e10ce64 links to Go Nuts, issue tracker,
source code browser on code.google.com
(where LICENSE file is visible)

R=r
http://go/go-review/1024023
2009-11-08 09:50:16 -08:00
Robert Griesemer
a011480ff3 TBR
1st step of renaming dirList.html -> dirlist.html
(OS X filenames are not capitalization-sensitive)

R=rsc
http://go/go-review/1024021
2009-11-08 00:51:08 -08:00
Robert Griesemer
5de21eb1e9 TBR
step 2: adding renamed dirlist.html again

R=rsc
http://go/go-review/1024022
2009-11-08 00:49:56 -08:00
Robert Griesemer
642caacfa3 - added link to sources
- renamed listing.html -> dirList.html
  (there is a dirs.html already, it should probably have a better name, too)

R=rsc
http://go/go-review/1025020
2009-11-07 21:24:48 -08:00
Robert Griesemer
171ef39949 nice directory listings
R=rsc
http://go/go-review/1026020
2009-11-07 21:12:46 -08:00
Russ Cox
213bd39a3b fix a few style nits; arrange the doc list in
an order we want people to read the docs.

R=r
CC=go-dev
http://go/go-review/1025017
2009-11-07 16:46:49 -08:00
Robert Griesemer
1ac60ddd10 - support to extract one-line package synopsis for package listings
- formatting in dirs.html is crude, needs better html (open to suggestions),
  but shows the synopsis
- many package comments should probably be adjusted such that the first
  sentence is more concise

R=rsc, iant
http://go/go-review/1025014
2009-11-07 13:17:53 -08:00
Russ Cox
b94f8131ae new style; live at http://r45:3456/
R=r
CC=go-dev
http://go/go-review/1026015
2009-11-07 12:11:28 -08:00
Rob Pike
f93ecca397 add a place-holder link for the hour-long video
R=rsc
CC=go-dev
http://go/go-review/1017054
2009-11-05 13:46:12 -08:00
Adam Langley
51c1bd229b godoc: style update.
R=r, rsc
CC=go-dev
http://go/go-review/1017051
2009-11-05 12:18:54 -08:00
Robert Griesemer
d06dc14aa8 remove "em" unit from td width specification
R=rsc
http://go/go-review/1018037
2009-11-04 10:58:13 -08:00
Adam Langley
b9ec2adfc7 Update the styling of the godoc pages.
(root.html is just temporary. It'll need some better content.)

R=r
CC=go-dev
http://go/go-review/1017019
2009-11-03 19:59:45 -08:00
Robert Griesemer
4818d346b6 support for command documentation:
- made package tree handler generic so it can work on any fs tree
- cleanups along the way

R=rsc
CC=r
http://go/go-review/1017020
2009-11-03 19:40:26 -08:00
Robert Griesemer
be56b95770 - show recursive package directory structure in package pages
- removed some underbars in section headings for better looks
- various minor tweaks

R=rsc
http://go/go-review/1018026
2009-11-02 22:44:01 -08:00
Robert Griesemer
49d295d592 - initial steps towards showing directory tree instead of
just a single directory
- all pieces present but not well integrated
- directory tree served at the moment under /tree

R=rsc
http://go/go-review/1018016
2009-11-02 09:25:39 -08:00
Robert Griesemer
c54cb4cb4d - added missing formatters in templates
- replaced deprecated use of </font> with </span> tag
- added html escaping to godoc formatters where missing
- enabled text format for package documentation

R=rsc
http://go/go-review/1017001
2009-10-28 16:19:09 -07:00
Robert Griesemer
8b2d2847a8 html-escaping of fields that may be user-generated
R=rsc
http://go/go-review/1013019
2009-10-28 12:52:52 -07:00
Robert Griesemer
e3fd2e1ec6 godoc search bug fixes:
- sort by package name (instead of package path) for results with snippets
- sort line numbers in results without snippets
- properly characterize package clauses
- experiment with a leaner look: no underlines for top-level godoc links in the left side bar

Still using colors to distinguish results. Next step.

R=rsc
http://go/go-review/1015016
2009-10-27 16:08:12 -07:00
Robert Griesemer
32810a5ded code search for godoc:
- added goroutine to automatically index in the background
- added handler for search requests
- added search box to top-level godoc template
- added search.html template for the display of search results
- changes to spec.go because of name conflicts
- added extra styles to style.css (for shorter .html files)

R=rsc
http://go/go-review/1014011
2009-10-27 10:34:31 -07:00
Russ Cox
09fe283489 main landing pages
R=r
DELTA=55  (7 added, 34 deleted, 14 changed)
OCL=35984
CL=35986
2009-10-22 00:13:36 -07:00
Robert Griesemer
53440da835 Factored out boilerplate from all html docs in doc directory:
- the first HTML comment in those files is extracted as page
  title when serving them
- lib/godoc.html is top-level template for all pages served
- experimented a bit with package documentation layout
  (feedback welcome)
- various related cleanups

TODO:
- The / page (doc/root.html) content repeats links that are
  in the navigation bar. It needs to be cleaned up.

R=rsc
DELTA=826  (86 added, 692 deleted, 48 changed)
OCL=35230
CL=35245
2009-10-01 14:08:00 -07:00
Robert Griesemer
ec8c611b40 - use new css for godoc templates
- final location of files TBD

R=rsc,r
DELTA=84  (19 added, 46 deleted, 19 changed)
OCL=34758
CL=34761
2009-09-17 17:04:51 -07:00
Robert Griesemer
3dc7b382f9 associate const and var declarations with a type where possible
R=rsc
DELTA=105  (87 added, 7 deleted, 11 changed)
OCL=34062
CL=34119
2009-08-31 10:47:34 -07:00
Robert Griesemer
178089056e printer.go:
- emit line tag id's in html mode
- support for general html tags
- better names for a few identifiers

godoc.go:
- emit links from exported names to source code
  (actual placement needs fine-tuning)

R=rsc
DELTA=108  (68 added, 4 deleted, 36 changed)
OCL=32639
CL=32654
2009-08-03 09:53:00 -07:00
Robert Griesemer
90e6656c51 go/ast/filter.go:
- more orthogonal functionality of filter functions for better re-use

go/doc/doc.go:
- simplified interface
- collect filenames of packages so that they can be shown

godoc:
- removed TODO, show list of package (linked) files used to create documentation

R=rsc
DELTA=130  (68 added, 24 deleted, 38 changed)
OCL=32549
CL=32552
2009-07-30 18:13:55 -07:00
Robert Griesemer
38e7fddc21 Show BUG comments in godoc:
ast.go:
- rename Comments -> CommentGroup (less confusion)
- change all comments/docs to be *CommentGroup

filter.go:
- do not remove unassociated comments from program as part
  of export filtering (they are needed by doc.go for BUG comments)

scanner.go:
- exclude '\n' from //-style comments

parser.go:
- rewrote collection of comments: now all collected comments
  are *ast.CommentGroups
- clarified distinction between leading and trailing comments
- fixed a bug in comment collection (parseGenDecl);
  corresponding test case is in printer/testdata
- extra documentation

doc.go:
- collect BUG comments
- corresponding fix for parser bug in comment collection

comment.go:
- simplified regex

printer.go:
- adjust comment printing to new representation

printer_test.go, testdata/*:
- enable printing of doc comments
- extended tests

package.html, package.txt:
- added Bugs section

gofmt:
- enable printing of doc comments

R=rsc
DELTA=339  (126 added, 38 deleted, 175 changed)
OCL=31403
CL=31416
2009-07-09 16:38:17 -07:00
Rob Pike
ee23998963 tweak the newlines so the headers stand out better.
old:
	CONSTANTS
	const (
	    MissingKind = iota;
	  )
new:
	CONSTANTS

	const (
	    MissingKind = iota;
	 )

R=gri,rsc
DELTA=4  (4 added, 0 deleted, 0 changed)
OCL=30362
CL=30598
2009-06-22 14:18:23 -07:00
Rob Pike
3fd16ad0ed delete dreg comment
R=rsc
OCL=30359
CL=30359
2009-06-16 13:49:40 -07:00
Robert Griesemer
4c8fe766af - some fine-tuning of godoc templates per r's suggestion
- removed gratuitous newline in go/printer

R=r
DELTA=15  (2 added, 13 deleted, 0 changed)
OCL=30358
CL=30358
2009-06-16 13:44:15 -07:00
Robert Griesemer
5071a5a572 move godoc to src/cmd/godoc
R=rsc
DELTA=945  (944 added, 0 deleted, 1 changed)
OCL=30315
CL=30341
2009-06-16 09:14:06 -07:00