docs

package

v0.0.0-...-c734098 Latest Latest Go to latest Published: Aug 26, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/post04/dr-docso

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Synopsis(s string) string
type Doc
- func GetDoc(pkg string) (*Doc, error)
type Documentation
- func (d Documentation) Synposis() string
type Function
type FunctionType
type Type
- func (t Type) FullComment() string

Constants ¶

View Source

const BASE = "https://pkg.go.dev/"

Variables ¶

This section is empty.

Functions ¶

func Synopsis ¶

func Synopsis(s string) string

Types ¶

type Doc ¶

type Doc struct {
	URL       string     `json:"url"`
	Name      string     `json:"name"`
	Overview  string     `json:"overview"`
	Types     []Type     `json:"types"`
	Functions []Function `json:"functions"`
}

func GetDoc ¶

func GetDoc(pkg string) (*Doc, error)

GetDoc returns a document representing the specified package/module.

type Documentation ¶

type Documentation string

func (Documentation) Synposis ¶

func (d Documentation) Synposis() string

type Function ¶

type Function struct {
	Name      string       `json:"name"`
	Type      FunctionType `json:"type"`
	Signature string       `json:"signature"`
	MethodOf  string       `json:"methodOf"`

	Example  string   `json:"example"`
	Comments []string `json:"comments"`
}

type FunctionType ¶

type FunctionType string

const (
	FnNormal FunctionType = "normal"
	FnMethod FunctionType = "method"
)

type Type ¶

type Type struct {
	Name      string `json:"name"`
	Type      string `json:"type"`
	Signature string `json:"signature"`

	Comments []string `json:"comments"`
}

func (Type) FullComment ¶

func (t Type) FullComment() string

FullComment returns the entire comment from Type.Comments, joined with new lines.

Source Files ¶

View all Source files

docs.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL