README
¶
Docreflect
Library and command to help accessing go doc comments during runtime.
Go doc comments are not accessible during runtime via reflection. To make them avaiable during runtime, we need to capture them during build time. The docreflect command, or the docreflect/generate library package, fetches the go doc comments of the specified declarations, and generates Go code that registers the docs for every declaration. Code that includes the generated initialization code, will have the docs accessible via the top level docreflect package methods.
Declarations:
- the declarations must be absolute Go paths
- when passing in the import path of a package, all the top level symbols of the package, plus the struct fields and methods of the top level types will be included
- the package documentation can be fetched using
docreflect.Docs("absolute/import/path/of/package") - when passing in the import path of only the selected symbols, the rest of the package level symbols will be ignroed
Gotchas:
- type aliases and type definitions based on named types are not resolved
- package imports are not resolved, necessary packages need to be included in the generate arguments
Library documentation: https://godocs.io/code.squareroundforest.org/arpio/docreflect
To insall the docreflect command, run:
make install
Usage of the docreflect command:
docreflect generate --package-name mypackage coderepos.org/jdoe/mypackage coderepos.org/jdoe/otherpackage > docreflect.go
Made in Berlin, DE
Documentation
¶
Overview ¶
Package docreflect returns the Go documentation for packages, types and functions.
The Go documentation of packages is not available during runtime by default, so in order to use docreflect, the documentation for the selected packages and symbols needs to be generated during build time. To generate the documentation, see the docreflect/generate package or the docreflect generate command.
Index ¶
- func Docs(gopath string) string
- func Field(t reflect.Type, fieldPath ...string) string
- func Function(v reflect.Value) string
- func FunctionParams(v reflect.Value) []string
- func Method(t reflect.Type, name string) string
- func MethodParams(t reflect.Type, name string) []string
- func Register(gopath, docs string)
- func Type(t reflect.Type) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Docs ¶
Docs returns the documentation for a package or a symbol in a package identified by its full go path.
func FunctionParams ¶
FunctionParams returns the list of the parameter names of a package level function.
func MethodParams ¶
MethodParams returns the list of the parameter names of a type method.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
docreflect
command
|
|
|
Package generate provides a generator to generate go code from go docs that registers doc entries for use with the docreflect package.
|
Package generate provides a generator to generate go code from go docs that registers doc entries for use with the docreflect package. |
|
internal
|
|
|
tests/src/command
command
|
|
|
tests/src/testpackage
Package testpackage is a test package
|
Package testpackage is a test package |