Documentation
¶
Index ¶
- Constants
- Variables
- func ReadDebug(roots []string)
- type DataIndex
- type Element
- type Index
- func (ind *Index) DataIndex() *DataIndex
- func (ind *Index) Date() string
- func (_ *Index) HumainDate() string
- func (ind Index) ListFile() (files []string)
- func (ind Index) ListLang() (out []string)
- func (ind Index) ListType() (files []string)
- func (ind *Index) SaveHTML(path string)
- func (_ *Index) Title() string
Constants ¶
View Source
const ( TYPE_NODEF = 0 TYPE_COMMENT = 1 TYPE_CODE = 2 TYPE_FUNCTION = 3 TYPE_TYPEDEF = 4 TYPE_MACROCONST = 5 TYPE_MACROFUNC = 6 TYPE_CONST = 7 TYPE_CLASS = 8 TYPE_VAR = 9 )
Variables ¶
View Source
var Title string = ""
Functions ¶
Types ¶
type DataIndex ¶
The index for XML and JSON encoding
type Element ¶
type Element struct {
// The name of the element
Name string
// The header of the element
LineName string
// The type: func, var, const, class ...
Type string
// The file where are the definition of the element
FileName string
// The line of the definition in the file
LineNum int
// The comment before the element. Each item is a paragraph.
Comment []string
// The language of the file
Lang string
}
On element: function, var, typedef, class ...
type Index ¶
type Index []*Element
All the element of a project
func (Index) ListFile ¶
List all file who have an element of the list. The return list are sorted and all file are uniq
func (Index) ListLang ¶
List all file who have an element of the list. The return list are sorted and all file are uniq
Source Files
¶
Click to show internal directories.
Click to hide internal directories.