doc

Documentation

Overview

Package doc implemented fetch projects from VCS and genarate AST.

Index

• Constants
• Variables
• func CheckDoc(broPath, tag string, rt requestType) (*hv.Package, error)
• func CodeEncode(code *string) *string
• func GetGithubCredentials() string
• func RenderFuncs(pdoc *hv.Package) []models.PkgFunc
• func SaveProject(pdoc *hv.Package, pfuncs []models.PkgFunc) (int64, error)
• func SetGithubCredentials(id, secret string)

Constants

const (
	RT_Human requestType = iota
	RT_Refresh
)

Variables

var (
	HttpClient = &http.Client{Transport: httpTransport}
)

Functions

func CheckDoc

func CheckDoc(broPath, tag string, rt requestType) (*hv.Package, error)

CheckDoc returns 'Package' by given import path and tag, or fetch from the VCS and render as needed. It returns error when error occurs in the underlying functions.

func CodeEncode

func CodeEncode(code *string) *string

func GetGithubCredentials

func GetGithubCredentials() string

func RenderFuncs

func RenderFuncs(pdoc *hv.Package) []models.PkgFunc

func SaveProject

func SaveProject(pdoc *hv.Package, pfuncs []models.PkgFunc) (int64, error)

SaveProject saves project information to database.

func SetGithubCredentials

func SetGithubCredentials(id, secret string)