parse

Documentation

Index

• Variables
• func GetDescription(longFnName string) (desc string)
• func GetTitle(longFnName string) string
• func IsFuncInPkg(longFnName string) bool
• func NewPackageDoc(dir string) (*doc.Package, error)
• func SetParamsType(paramsType *reflect.Type)
• func SetURLVarExtractor(fn *URLVarExtractor)
• type URLVarExtractor

Variables

var ParamsType *reflect.Type

Functions

func GetDescription

func GetDescription(longFnName string) (desc string)

func GetTitle

func GetTitle(longFnName string) string

GetTitle extracts a title from the function name, where longFnName is of the form: github.com/adams-sarah/test2doc/example.GetWidget and the out title would be: Handle Get Widget

func IsFuncInPkg

func IsFuncInPkg(longFnName string) bool

IsFuncInPkg checks if this func belongs to the package

func NewPackageDoc

func NewPackageDoc(dir string) (*doc.Package, error)

NewPackageDoc retrieves the go/doc package for the given dir

func SetParamsType

func SetParamsType(paramsType *reflect.Type)

func SetURLVarExtractor

func SetURLVarExtractor(fn *URLVarExtractor)

Types

type URLVarExtractor

type URLVarExtractor func(req *http.Request) (vars map[string]string)

var Extractor *URLVarExtractor