gen

README

BLueZ docs parser & generator

This software parse doc bluez folder and output a set of struct to interact with the bluez DBus API.

Usage:

Env variables

• BASEDIR base directory for docs and generation output, default ./
• FILE_FILTER filter docs files by name
• API_FILTER filter docs API by name
• METHOD_FILTER filter docs API method by name
• LOG_LEVEL tune CLI log level output

Notes

• Generated files have a gen_ prefix, followed by the API name
• If a <API name>.go file exists, it will be skipped from the generation. This to allow custom code to live with generated one.
• Generation process does not overwrite existing files, ensure to remove previously generated files.

Documentation

Index

• type BluezAPI
  • func LoadJSON(srcFile string) (*BluezAPI, error)
  • func Parse(docsDir string, filtersList []filters.Filter, debug bool) (BluezAPI, error)
  • func (g *BluezAPI) Serialize(destFile string) error

Types

type BluezAPI

type BluezAPI struct {
	Version string
	Api     []*types.ApiGroup
}

func LoadJSON

func LoadJSON(srcFile string) (*BluezAPI, error)

LoadJSON parse an ApiGroup from JSON definition

func Parse

func Parse(docsDir string, filtersList []filters.Filter, debug bool) (BluezAPI, error)

Parse bluez DBus API docs

func (*BluezAPI) Serialize

func (g *BluezAPI) Serialize(destFile string) error

Serialize store the structure as JSON