gen

package
v0.0.0-...-7f43d4a Latest Latest
Warning

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

Go to latest
Published: Jul 12, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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