mirror of
https://github.com/robertkrimen/otto
synced 2025-09-28 18:45:22 +08:00
Add README.markdown for registry
This commit is contained in:
parent
84b4aee178
commit
49dc256af8
2
Makefile
2
Makefile
|
|
@ -46,7 +46,7 @@ test-all: test-i
|
||||||
go test .
|
go test .
|
||||||
|
|
||||||
release: test-all test-synopsis
|
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
|
test-synopsis: test-i
|
||||||
cd .test && go test -v
|
cd .test && go test -v
|
||||||
|
|
|
||||||
48
registry/README.markdown
Normal file
48
registry/README.markdown
Normal file
|
|
@ -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
|
||||||
|
|
@ -45,3 +45,6 @@ Enable underscore runtime inclusion.
|
||||||
func Source() string
|
func Source() string
|
||||||
```
|
```
|
||||||
Source returns the underscore source.
|
Source returns the underscore source.
|
||||||
|
|
||||||
|
--
|
||||||
|
**godocdown** http://github.com/robertkrimen/godocdown
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user