1
0
mirror of https://github.com/golang/go synced 2024-10-03 23:21:22 -06:00
go/doc
Volker Dobler a6729b3085 go/doc: Detect headings in comments and format them as h3 in html.
To structure larger sections of comments in html output headings
are detected in comments and formated as h3 in the generated html.
A simple heuristic is used to detect headings in comments:
A heading is a non-blank, non-indented line preceded by a blank
line. It is followed by a blank and a non-blank, non-indented line.
A heading must start with an uppercase letter and end with a letter,
digit or a colon.  A heading may not contain punctuation characters.

R=jan.mercl, gri, adg, rsc, r
CC=golang-dev
https://golang.org/cl/5437056
2011-12-01 09:49:58 -08:00
..
codelab/wiki text/template: new, simpler API 2011-11-23 20:17:22 -08:00
codewalk renaming_4: gofix -r everything/but/src/pkg 2011-11-08 15:43:02 -08:00
devel weekly.2011-12-01 2011-12-01 16:17:24 +11:00
gopher doc/gopher: add a small gif to use as an app engine logo on GAE pages. 2011-06-14 17:25:57 +10:00
play godoc: add dummy playground.js to silence godoc warning at start-up 2011-08-22 14:06:07 -07:00
progs doc/progs: fix windows version to satisfy new error 2011-11-14 20:53:03 +11:00
talks renaming_4: gofix -r everything/but/src/pkg 2011-11-08 15:43:02 -08:00
all.css go/doc: Detect headings in comments and format them as h3 in html. 2011-12-01 09:49:58 -08:00
button_background.png golang.org redesign 2010-09-16 14:01:02 +10:00
code.html doc: there's no such thing as a .cgo file 2011-03-04 16:28:27 +11:00
codereview_with_mq.html doc: various changes for validating HTML 2010-08-30 09:58:27 +10:00
community.html golang.org redesign 2010-09-16 14:01:02 +10:00
contrib.html doc: put Release History link on 'Documentation' page 2011-05-27 16:07:30 +10:00
contribute.html contrib*.html: make "golang-dev" the default reviewer. 2011-05-13 16:25:31 -07:00
debugging_with_gdb.html all: rename os.Error to error in various non-code contexts 2011-11-01 22:58:09 -04:00
docs.html doc: link to Chinese translation of A Tour of Go 2011-11-18 15:22:48 +11:00
effective_go.html effective_go: remove unused variable from a couple of examples 2011-11-24 08:51:47 -08:00
effective_go.tmpl effective_go: remove unused variable from a couple of examples 2011-11-24 08:51:47 -08:00
ExpressivenessOfGo.pdf fix bug in example. need to convert Value to float in Abs example 2010-10-18 16:05:50 -07:00
frontpage.css doc: add I/O 2011 talks to talks/, docs.html, and front page. 2011-05-17 13:46:54 +10:00
gccgo_contribute.html docs: make "runtime" a word only as a name for the package. 2011-03-01 13:54:22 -08:00
gccgo_install.html doc: when configuring gold for gccgo, use --enable-gold=default 2011-09-19 11:54:07 -07:00
go_faq.html FAQ: rearrange and expand the discussion of testing 2011-11-09 13:19:23 -08:00
go_for_cpp_programmers.html docs: make "runtime" a word only as a name for the package. 2011-03-01 13:54:22 -08:00
go_mem.html doc: fix memory model read visibility bug 2011-09-26 12:54:30 -04:00
go_spec.html spec: update spacing to match gofmt, where reasonable. 2011-11-29 15:47:36 -08:00
go_tutorial.html tutorial: update go_tutorial.html 2011-11-22 11:53:30 -08:00
go_tutorial.tmpl tutorial: describe unidirectional channels 2011-11-10 14:02:14 -08:00
go-logo-black.png godoc: style update. 2009-11-05 12:18:54 -08:00
go-logo-blue.png Update the styling of the godoc pages. 2009-11-03 19:59:45 -08:00
go-logo-white.png create doc/talks/. 2010-01-13 16:26:22 -08:00
GoCourseDay1.pdf doc/GoCourseDay1: shrink the PDF by rewriting it using ps2pdf. 2011-06-20 12:36:14 +10:00
GoCourseDay2.pdf docs: Update notes for 3-day Go course. 2011-06-10 15:05:51 +10:00
GoCourseDay3.pdf docs: Update notes for 3-day Go course. 2011-06-10 15:05:51 +10:00
godocs.js godoc: generate package toc in template, not in JavaScript 2011-10-18 16:23:35 -04:00
ie.css golang.org redesign 2010-09-16 14:01:02 +10:00
install.html codereview: undo last night's rollback 2011-11-18 12:58:44 -05:00
logo-153x55.png new logo 2009-10-12 22:58:32 -07:00
logo.png golang.org redesign 2010-09-16 14:01:02 +10:00
Makefile doc/Makefile: add 'all' rule to build all docs 2011-11-01 09:45:04 -07:00
makehtml effective_go: convert to use tmpltohtml. 2011-08-21 09:46:19 +10:00
play_overlay.png golang.org redesign 2010-09-16 14:01:02 +10:00
playground.html playground.html: filesystem is not a word. 2010-10-06 23:56:13 +02:00
popups.js godoc: initial support for showing popup information 2010-03-16 14:17:42 -07:00
root.html doc: refer to tour.golang.org instead of go-tour.appspot.com 2011-11-01 16:09:29 +09:00
sieve.gif repair corrupted sieve.gif 2009-10-30 10:34:01 -07:00
tmpltohtml.go doc/tmptohtml: output fix 2011-11-28 09:50:40 -08:00
video-001.png golang.org redesign 2010-09-16 14:01:02 +10:00
video-002.png golang.org redesign 2010-09-16 14:01:02 +10:00
video-003.png golang.org redesign 2010-09-16 14:01:02 +10:00
video-004.png doc: add Practical Go Programming to front page and docs.html 2010-12-03 06:57:30 +09:00
video-005.jpg doc: add I/O 2011 talks to talks/, docs.html, and front page. 2011-05-17 13:46:54 +10:00