doc

package
v0.0.0-...-4bdbd43 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 19, 2014 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Overview

Package doc implemented fetch projects from VCS and genarate AST.

Index

Constants

View Source
const (
	RT_Human requestType = iota
	RT_Refresh
)

Variables

View Source
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)

Types

This section is empty.

Jump to

Keyboard shortcuts

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