# Packages
Package comment implements parsing and reformatting of Go doc comments,
(documentation comments), which are comments that immediately precede
a top-level declaration of a package, const, func, type, or var.
# Functions
Examples returns the examples found in testFiles, sorted by Name field.
IsPredeclared reports whether s is a predeclared identifier.
New computes the package documentation for the given package AST.
NewFromFiles computes documentation for a package.
Synopsis returns a cleaned version of the first sentence in text.
ToHTML converts comment text to formatted HTML.
ToText converts comment text to formatted text.
# Constants
AllDecls says to extract documentation for all package-level declarations, not just exported ones.
AllMethods says to show all embedded methods, not just the ones of invisible (unexported) anonymous fields.
PreserveAST says to leave the AST unmodified.
# Variables
IllegalPrefixes is a list of lower-case prefixes that identify a comment as not being a doc comment.
# Structs
An Example represents an example function found in a test source file.
Func is the documentation for a func declaration.
A Note represents a marked comment starting with "MARKER(uid): note body".
Package is the documentation for an entire package.
Type is the documentation for a type declaration.
Value is the documentation for a (possibly grouped) var or const declaration.