diff --git a/Makefile b/Makefile index 3ba1475..147d848 100644 --- a/Makefile +++ b/Makefile @@ -46,7 +46,7 @@ test-all: test-i go test . release: test-all test-synopsis - godocdown --signature > README.markdown + for package in . underscore registry; do (cd $$package && godocdown --signature > README.markdown); done test-synopsis: test-i cd .test && go test -v diff --git a/registry/README.markdown b/registry/README.markdown new file mode 100644 index 0000000..1f1f61c --- /dev/null +++ b/registry/README.markdown @@ -0,0 +1,48 @@ +# registry +-- +Package registry is an expirmental package to facillitate altering the otto runtime via import. + +This interface can change at any time. + +## Usage + +#### func Apply + +```go +func Apply(callback func(Entry)) +``` + +#### type Entry + +```go +type Entry struct { +} +``` + + +#### func Register + +```go +func Register(source string) *Entry +``` + +#### func (*Entry) Disable + +```go +func (self *Entry) Disable() +``` + +#### func (*Entry) Enable + +```go +func (self *Entry) Enable() +``` + +#### func (Entry) Source + +```go +func (self Entry) Source() string +``` + +-- +**godocdown** http://github.com/robertkrimen/godocdown diff --git a/underscore/README.markdown b/underscore/README.markdown index ac20a71..801f853 100644 --- a/underscore/README.markdown +++ b/underscore/README.markdown @@ -45,3 +45,6 @@ Enable underscore runtime inclusion. func Source() string ``` Source returns the underscore source. + +-- +**godocdown** http://github.com/robertkrimen/godocdown