apigen

Documentation

Overview

This package implements automated mumax API generation. Based on the exported methods of engine.API, an API library in any of the supported programming languages is automatically generated.

Author: Arne Vansteenkiste

This package implements automated mumax API generation. Based on the exported methods of engine.API, an API library in any of the supported programming languages is automatically generated.

Author: Arne Vansteenkiste

Index

• func APIGen()
• type Lang
• type Python
  • func (p *Python) Comment() string
  • func (p *Python) Filename() string
  • func (p *Python) WriteFooter(out io.Writer)
  • func (p *Python) WriteFunc(out io.Writer, name string, comment []string, argNames []string, ...)
  • func (p *Python) WriteHeader(out io.Writer)
• type Tex
  • func (p *Tex) Comment() string
  • func (p *Tex) Filename() string
  • func (p *Tex) WriteFooter(out io.Writer)
  • func (p *Tex) WriteFunc(out io.Writer, name string, comment []string, argNames []string, ...)
  • func (p *Tex) WriteHeader(out io.Writer)

Functions

func APIGen

func APIGen()

Auto-generate API libraries for all languages.

Types

type Lang

type Lang interface {
	Filename() string          //file name for the API file
	Comment() string           //Comment token like # or //
	WriteHeader(out io.Writer) //Write the header of the source file
	WriteFooter(out io.Writer) // Write the footer of the source file
	WriteFunc(out io.Writer,
		name string,
		comment []string,
		argNames []string,
		argTypes []reflect.Type,
		returnTypes []reflect.Type) // Write a function wrapper to the source file
}

Represents a programming language.

type Python

type Python struct{}

func (*Python) Comment

func (p *Python) Comment() string

func (*Python) Filename

func (p *Python) Filename() string

func (*Python) WriteFooter

func (p *Python) WriteFooter(out io.Writer)

func (*Python) WriteFunc

func (p *Python) WriteFunc(out io.Writer, name string, comment []string, argNames []string, argTypes []reflect.Type, returnTypes []reflect.Type)

func (*Python) WriteHeader

func (p *Python) WriteHeader(out io.Writer)

type Tex

type Tex struct{}

Does not generate a true API library, but a TeX file with API documentation.

func (*Tex) Comment

func (p *Tex) Comment() string

func (*Tex) Filename

func (p *Tex) Filename() string

func (*Tex) WriteFooter

func (p *Tex) WriteFooter(out io.Writer)

func (*Tex) WriteFunc

func (p *Tex) WriteFunc(out io.Writer, name string, comment []string, argNames []string, argTypes []reflect.Type, returnTypes []reflect.Type)

func (*Tex) WriteHeader

func (p *Tex) WriteHeader(out io.Writer)