Documentation ¶
Overview ¶
Package natspec provides DevDoc, UserDoc, and DocUnion structs which correlate with Ethereum compiler natspec output
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DevDoc ¶
type DevDoc struct { Author string `json:"author,omitempty"` Construction []map[string]string `json:"construction,omitempty"` Invariants []map[string]string `json:"invariants,omitempty"` Methods map[string]*Method `json:"methods,omitempty"` Title string `json:"title,omitempty"` }
DevDoc The output of an ethereum compiler's natspec developer documentation
type DocUnion ¶
type DocUnion struct { Author string `json:"author,omitempty"` Construction []map[string]string `json:"construction,omitempty"` Invariants []map[string]string `json:"invariants,omitempty"` Language string `json:"language,omitempty"` LanguageVersion string `json:"languageVersion,omitempty"` Methods map[string]*Method `json:"methods,omitempty"` Source string `json:"source,omitempty"` Title string `json:"title,omitempty"` }
DocUnion The union of devdoc and userdoc
func (*DocUnion) CreateUnion ¶
CreateUnion takes a DevDoc and UserDoc struct and combines them into a DocUnion struct
type Method ¶
type Method struct { Details string `json:"details,omitempty"` Params map[string]string `json:"params,omitempty"` Return string `json:"return,omitempty"` }
Method defines a method object in the doc json
type UserDoc ¶
type UserDoc struct { Construction []map[string]string `json:"construction,omitempty"` Invariants []map[string]string `json:"invariants,omitempty"` Language string `json:"language,omitempty"` LanguageVersion string `json:"languageVersion,omitempty"` Methods map[string]*Method `json:"methods,omitempty"` Source string `json:"source,omitempty"` }
UserDoc The output of am ethereum compiler's natspec user documentation
Click to show internal directories.
Click to hide internal directories.