doxy

README

Doxygen XML parser for Go

See Godoc.

Documentation

Overview

Package doxy provides tools for parsing Doxygen XML files as generated by GENERATE_XML=YES.

Index

• type Entry
  • func (f *Entry) Decode() (*xmlfile.DoxygenType, error)
• type Index
  • func OpenXML(dir string) (*Index, error)
  • func (idx *Index) Entries() []Entry

Types

type Entry

type Entry struct {
	xmlindex.CompoundType
	// contains filtered or unexported fields
}

Entry is a of top-level Doxygen entry (file, struct).

func (*Entry) Decode

func (f *Entry) Decode() (*xmlfile.DoxygenType, error)

Decode decodes an entry's content.

type Index

type Index struct {
	// contains filtered or unexported fields
}

Index is a Doxygen XML directory index.

func OpenXML

func OpenXML(dir string) (*Index, error)

OpenXML opens a directory containing Doxygen XML files.

func (*Index) Entries

func (idx *Index) Entries() []Entry

Entries returns a list of top-level Doxygen entries (files, structs).