Class RenderAdapt

Intermediate class for report renderer.

This class follows the pattern with inheritance from Lua classes.

Metamethods

RenderAdapt:__index (key) Lookup of missing class members.

Methods

RenderAdapt:create (...) Create a new instance.
RenderAdapt:_init (...) Initialize a new instance.
RenderAdapt:key (str) Override key construction.
RenderAdapt:realizeState (src, lang, counter) Realize reported data for state.
RenderAdapt:realizeHeader (src, lang, counter) Realize reported data for header.
RenderAdapt:realizeLine (param, lang) Realize reported data for a line.
RenderAdapt:realizeBody (src, lang) Realize reported data for body.


Metamethods

RenderAdapt:__index (key)
Lookup of missing class members.

Parameters:

Returns:

any

Raises:

on wrong arguments

Methods

RenderAdapt:create (...)
Create a new instance.

Parameters:

Returns:

self

See also:

RenderAdapt:_init (...)
Initialize a new instance.

Parameters:

Returns:

self
RenderAdapt:key (str)
Override key construction.

Parameters:

  • str string to be appended to a base string

Returns:

string

Raises:

on wrong arguments
RenderAdapt:realizeState (src, lang, counter)
Realize reported data for state.

Parameters:

  • src Report that shall be realized
  • lang nil or string code used for realization
  • counter nil or Counter holding the running count

Returns:

string

Raises:

on wrong arguments
RenderAdapt:realizeHeader (src, lang, counter)
Realize reported data for header. The "header" is a composite.

Parameters:

  • src Report that shall be realized
  • lang nil or string code used for realization
  • counter nil or Counter holding the running count

Returns:

string

Raises:

on wrong arguments
RenderAdapt:realizeLine (param, lang)
Realize reported data for a line.

Parameters:

  • param any that shall be realized
  • lang nil or string code used for realization

Returns:

string

Raises:

on wrong arguments
RenderAdapt:realizeBody (src, lang)
Realize reported data for body. The "body" is a composite.

Parameters:

  • src Report that shall be realized
  • lang nil or string code used for realization

Returns:

string

Raises:

on wrong arguments
generated by LDoc 1.4.6