Class RenderCase

Intermediate class for case report renderer.

This class follows the pattern with inheritance from Lua classes.

Metamethods

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

Methods

RenderCase:create (...) Create a new instance.
RenderCase:_init (...) Initialize a new instance.
RenderCase:key (str) Override key construction.
RenderCase:realizeState (src, lang, counter) Realize reported data for state.
RenderCase:realizeSkip (src, lang) Realize reported data for skip.
RenderCase:realizeTodo (src, lang) Realize reported data for todo.
RenderCase:realizeDescription (src, lang) Realize reported data for description.
RenderCase:realizeName (src, lang) Realize reported data for name.
RenderCase:realizeHeader (src, lang, counter) Realize reported data for header.
RenderCase:realizeBody (src, lang) Realize reported data for body.


Metamethods

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

Parameters:

Returns:

any

Raises:

on wrong arguments

Methods

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

Parameters:

Returns:

self

See also:

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

Parameters:

Returns:

self
RenderCase:key (str)
Override key construction.

Parameters:

  • str string to be appended to a base string

Returns:

string
RenderCase: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
RenderCase:realizeSkip (src, lang)
Realize reported data for skip. The "skip" is a message identified by a key.

Parameters:

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

Returns:

string

Raises:

on wrong arguments
RenderCase:realizeTodo (src, lang)
Realize reported data for todo. The "todo" is a text string.

Parameters:

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

Returns:

string

Raises:

on wrong arguments
RenderCase:realizeDescription (src, lang)
Realize reported data for description. The "description" is a text string.

Parameters:

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

Returns:

string

Raises:

on wrong arguments
RenderCase:realizeName (src, lang)
Realize reported data for name. The "name" is a text string.

Parameters:

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

Returns:

string

Raises:

on wrong arguments
RenderCase: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
RenderCase: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 (unused)

Returns:

string

Raises:

on wrong arguments
generated by LDoc 1.4.6