package
0.3.1
Repository: https://github.com/caicloud/nirvana.git
Documentation: pkg.go.dev

# Functions

DescriptorForData generates a Descriptor for API docs page.
GenSwaggerPageData generates a Swagger UI page based on the given API files.
NewAnalyzer creates a code analyzer.
NewBuffer creates a buffer.
NewContainer creates API container.
NewDefinition creates openapi.Definition from definition.Definition.
NewDefinitions creates a list of definitions.
NewPathDefinitions creates a list of definitions with path.
NewTypeContainer creates a type container.
ParseComments parses comments and extracts nirvana options.
PathForVersion returns the path of API file.
RPCDescriptorForData generates a RPCDescriptor for API docs page.
WriteFiles writes the API data into files.

# Constants

CommentsOptionAlias is the option name of alias.
CommentsOptionDescriptors is the option name of descriptors.
CommentsOptionModifiers is the option name of modifiers.
CommentsOptionOrigin is the option name of original name.
TypeNameInvalid indicates an invalid type name.

# Structs

Analyzer analyzes go packages.
Buffer provides a buffer to write data.
Comments is parsed from go comments.
Container contains informations to generate APIs.
Definition is complete version of def.Definition.
Definitions describes all APIs and its related object types.
Example is just an example.
FuncField describes a field of function.
Parameter describes a function parameter.
Result describes a function result.
StructField describes a field of a struct.
Type describes an go type.
TypeContainer contains types.

# Type aliases

TypeName is unique name for go types.