package
module
Version:
v0.0.0-...-ff13b7f
Opens a new window with list of versions in this module.
Published: Jun 19, 2016
License: BSD-3-Clause
Opens a new window with license information.
Imports: 13
Opens a new window with list of imports.
Imported by: 1
Opens a new window with list of known importers.
README
¶
pkgdoc
Package pkgdoc prepares package documentation from source.
Usage
package main
import (
"log"
"github.com/pnelson/pkgdoc"
)
func main() {
doc, err := pkgdoc.New("net")
if err != nil {
log.Fatal(err)
}
log.Println(doc.Synopsis)
}
Documentation
¶
Package pkgdoc prepares package documentation from source.
Doc represents source code documentation.
HTML returns the source code documentation as formatted HTML.
Function represents the documentation for functions.
Package represents package documentation.
New returns a new Package.
The package is loaded from source and must exist on the file system.
Type represents the documentation for types.
Value represents the documentation for values.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.