categorizer

Documentation

Index

• type Categories
• type Categorizer
  • func NewCategorizer(filepath string) *Categorizer
  • func (c *Categorizer) LoadJSON() error
  • func (c *Categorizer) WriteJSON(filename string) error
• type Codebase
• type Interface
• type Legend
• type Project
• type Root

Types

type Categories

type Categories struct {
	Slug       string      `json:"slug"`
	Name       string      `json:"name"`
	SeeAlso    []string    `json:"see_also,omitempty"`
	Interfaces []Interface `json:"interfaces"`
}

type Categorizer

type Categorizer struct {
	Root
	// contains filtered or unexported fields
}

func NewCategorizer

func NewCategorizer(filepath string) *Categorizer

func (*Categorizer) LoadJSON

func (c *Categorizer) LoadJSON() error

func (*Categorizer) WriteJSON

func (c *Categorizer) WriteJSON(filename string) error

type Codebase

type Codebase struct {
	Slug        string `json:"slug"`
	RepoURL     string `json:"repo_url"`
	LocalDirVar string `json:"local_dir_var"`
}

type Interface

type Interface struct {
	Package    string `json:"package"`
	Interface  string `json:"interface,omitempty"`
	Interfaces string `json:"interfaces,omitempty"`
}

type Legend

type Legend map[string]string

type Project

type Project struct {
	Name    string `json:"name"`
	About   string `json:"about"`
	RepoURL string `json:"repo_url"`
}

type Root

type Root struct {
	Project    Project      `json:"project"`
	Codebase   Codebase     `json:"codebase"`
	Legend     Legend       `json:"legend"`
	Categories []Categories `json:"categories"`
}