wip

Author: davecheney

examples/build/README.md

@@ -258,9 +258,9 @@ if set, or else the compiled code's GOARCH, GOOS, and GOROOT.
 
 
 ### func (\*Context) Import
-
-    func (ctxt *Context) Import(path string, srcDir string, mode ImportMode) (*Package, error)
-
+``` go
+func (ctxt *Context) Import(path string, srcDir string, mode ImportMode) (*Package, error)
+```
 Import returns details about the Go package named by the import path,
 interpreting local import paths relative to the srcDir directory.
 If the path is a local import path naming a package that can be imported
@@ -281,18 +281,18 @@ If an error occurs, Import returns a non-nil error and a non-nil
 
 
 ### func (\*Context) ImportDir
-
-    func (ctxt *Context) ImportDir(dir string, mode ImportMode) (*Package, error)
-
+``` go
+func (ctxt *Context) ImportDir(dir string, mode ImportMode) (*Package, error)
+```
 ImportDir is like Import but processes the Go package found in
 the named directory.
 
 
 
 ### func (\*Context) MatchFile
-
-    func (ctxt *Context) MatchFile(dir, name string) (match bool, err error)
-
+``` go
+func (ctxt *Context) MatchFile(dir, name string) (match bool, err error)
+```
 MatchFile reports whether the file with the given name in the given directory
 matches the context and would be included in a Package created by ImportDir
 of that directory.
@@ -303,16 +303,15 @@ read some or all of the file's content.
 
 
 ### func (\*Context) SrcDirs
-
-    func (ctxt *Context) SrcDirs() []string
-
+``` go
+func (ctxt *Context) SrcDirs() []string
+```
 SrcDirs returns a list of package source root directories.
 It draws from the current Go root and Go path but omits directories
 that do not exist.
 
 
 
-
 ## type ImportMode
 ``` go
 type ImportMode uint
@@ -341,7 +340,6 @@ const (
 
 
 
-
 ## type NoGoError
 ``` go
 type NoGoError struct {
@@ -363,10 +361,9 @@ test files, files hidden by build tags, and so on.)
 
 
 ### func (\*NoGoError) Error
-
-    func (e *NoGoError) Error() string
-
-
+``` go
+func (e *NoGoError) Error() string
+```
 
 
 ## type Package
@@ -444,9 +441,9 @@ ImportDir is shorthand for Default.ImportDir.
 
 
 ### func (\*Package) IsCommand
-
-    func (p *Package) IsCommand() bool
-
+``` go
+func (p *Package) IsCommand() bool
+```
 IsCommand reports whether the package is considered a
 command to be installed (not just a library).
 Packages named "main" are treated as commands.
@@ -459,7 +456,5 @@ Packages named "main" are treated as commands.
 
 
 
-
-
 - - -
 Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md)

examples/fs/README.md

@@ -43,7 +43,6 @@ FileSystem defines the methods of an abstract filesystem.
 
 
 
-
 ## type Walker
 ``` go
 type Walker struct {
@@ -83,19 +82,19 @@ WalkFS returns a new Walker rooted at root on the FileSystem fs.
 
 
 ### func (\*Walker) Err
-
-    func (w *Walker) Err() error
-
+``` go
+func (w *Walker) Err() error
+```
 Err returns the error, if any, for the most recent attempt
 by Step to visit a file or directory. If a directory has
 an error, w will not descend into that directory.
 
 
 
 ### func (\*Walker) Path
-
-    func (w *Walker) Path() string
-
+``` go
+func (w *Walker) Path() string
+```
 Path returns the path to the most recent file or directory
 visited by a call to Step. It contains the argument to Walk
 as a prefix; that is, if Walk is called with "dir", which is
@@ -104,27 +103,27 @@ a directory containing the file "a", Path will return "dir/a".
 
 
 ### func (\*Walker) SkipDir
-
-    func (w *Walker) SkipDir()
-
+``` go
+func (w *Walker) SkipDir()
+```
 SkipDir causes the currently visited directory to be skipped.
 If w is not on a directory, SkipDir has no effect.
 
 
 
 ### func (\*Walker) Stat
-
-    func (w *Walker) Stat() os.FileInfo
-
+``` go
+func (w *Walker) Stat() os.FileInfo
+```
 Stat returns info for the most recent file or directory
 visited by a call to Step.
 
 
 
 ### func (\*Walker) Step
-
-    func (w *Walker) Step() bool
-
+``` go
+func (w *Walker) Step() bool
+```
 Step advances the Walker to the next file or directory,
 which will then be available through the Path, Stat,
 and Err methods.
@@ -138,7 +137,5 @@ It returns false when the walk stops at the end of the tree.
 
 
 
-
-
 - - -
 Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md)

examples/martini/README.md

@@ -59,7 +59,6 @@ BeforeFunc is a function that is called before the ResponseWriter has been writt
 
 
 
-
 ## type ClassicMartini
 ``` go
 type ClassicMartini struct {
@@ -86,7 +85,6 @@ Classic creates a classic Martini with some basic default middleware - martini.L
 
 
 
-
 ## type Context
 ``` go
 type Context interface {
@@ -110,7 +108,6 @@ Context represents a request context. Services can be mapped on the request leve
 
 
 
-
 ## type Handler
 ``` go
 type Handler interface{}
@@ -149,7 +146,6 @@ Static returns a middleware handler that serves static files in the given direct
 
 
 
-
 ## type Martini
 ``` go
 type Martini struct {
@@ -177,47 +173,46 @@ New creates a bare bones Martini instance. Use this method if you want to have f
 
 
 ### func (\*Martini) Action
-
-    func (m *Martini) Action(handler Handler)
-
+``` go
+func (m *Martini) Action(handler Handler)
+```
 Action sets the handler that will be called after all the middleware has been invoked. This is set to martini.Router in a martini.Classic().
 
 
 
 ### func (\*Martini) Handlers
-
-    func (m *Martini) Handlers(handlers ...Handler)
-
+``` go
+func (m *Martini) Handlers(handlers ...Handler)
+```
 Handlers sets the entire middleware stack with the given Handlers. This will clear any current middleware handlers.
 Will panic if any of the handlers is not a callable function
 
 
 
 ### func (\*Martini) Run
-
-    func (m *Martini) Run()
-
+``` go
+func (m *Martini) Run()
+```
 Run the http server. Listening on os.GetEnv("PORT") or 3000 by default.
 
 
 
 ### func (\*Martini) ServeHTTP
-
-    func (m *Martini) ServeHTTP(res http.ResponseWriter, req *http.Request)
-
+``` go
+func (m *Martini) ServeHTTP(res http.ResponseWriter, req *http.Request)
+```
 ServeHTTP is the HTTP Entry point for a Martini instance. Useful if you want to control your own HTTP server.
 
 
 
 ### func (\*Martini) Use
-
-    func (m *Martini) Use(handler Handler)
-
+``` go
+func (m *Martini) Use(handler Handler)
+```
 Use adds a middleware Handler to the stack. Will panic if the handler is not a callable func. Middleware Handlers are invoked in the order that they are added.
 
 
 
-
 ## type Params
 ``` go
 type Params map[string]string
@@ -234,7 +229,6 @@ Params is a map of name/value pairs for named routes. An instance of martini.Par
 
 
 
-
 ## type ResponseWriter
 ``` go
 type ResponseWriter interface {
@@ -271,7 +265,6 @@ NewResponseWriter creates a ResponseWriter that wraps an http.ResponseWriter
 
 
 
-
 ## type ReturnHandler
 ``` go
 type ReturnHandler func(http.ResponseWriter, []reflect.Value)
@@ -291,7 +284,6 @@ that are passed into this function.
 
 
 
-
 ## type Route
 ``` go
 type Route interface {
@@ -311,7 +303,6 @@ Route is an interface representing a Route in Martini's routing layer.
 
 
 
-
 ## type Router
 ``` go
 type Router interface {
@@ -358,7 +349,6 @@ NewRouter creates a new Router instance.
 
 
 
-
 ## type Routes
 ``` go
 type Routes interface {
@@ -384,7 +374,5 @@ Routes is a helper service for Martini's routing layer.
 
 
 
-
-
 - - -
 Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md)