ConsoleDocFragment

Engine/source/console/console.h

An arbitrary fragment of auto-doc text for the script reference.

Public Attributes

const char *

mClass

The class in which to put the fragment.

const char *

mDefinition

The definition to output for this fragment.

ConsoleDocFragment *

mNext

Next fragment in the global link chain.

const char *

mText

The documentation text.

Public Static Attributes

ConsoleDocFragment *

smFirst

First fragment in the global link chain.

Public Functions

ConsoleDocFragment(const char * text, const char * inClass, const char * definition)

Detailed Description

An arbitrary fragment of auto-doc text for the script reference.

Public Attributes

const char * mClass

The class in which to put the fragment.

If NULL, the fragment will be placed globally.

const char * mDefinition

The definition to output for this fragment.

NULL for fragments not associated with a definition.

ConsoleDocFragment * mNext

Next fragment in the global link chain.

const char * mText

The documentation text.

Public Static Attributes

ConsoleDocFragment * smFirst

First fragment in the global link chain.

Public Functions

ConsoleDocFragment(const char * text, const char * inClass, const char * definition)