Example output

This output is generated with the following directive:

RST

.. lua:autoobject:: logging
   :members:
   :globals:
   :recursive:
   :index-table:
   :module-member-order: groupwise

Markdown

```{lua:autoobject} logging
:members:
:globals:
:recursive:
:index-table:
:module-member-order: groupwise
```

See logging.lua on github.

---

A generic logging module, just to demonstrate you documentation.

Index

Global

LOG_LEVEL

Default log level.

Class

Logger

An object for logging messages.

Enum

Level

Represents message severity.

Global

global LOG_LEVEL: logging.Level

Default log level.

Class

class logging.Logger

class ctor logging.Logger(name: string, level?: logging.Level)

An object for logging messages.

Parameters:

• name (string) – name of the logger, will be added to every message.

• level? (logging.Level) – level of the logger, equals to LOG_LEVEL by default.

debug(self, msg: string, ...: any)

Print a debug message.

Parameters:

• msg (string) – message format string, will be processed by string.format.

• ... (any) – parameters for message formatting.

info(self, msg: string, ...: any)

Print an info message.

Parameters:

• msg (string) – message format string, will be processed by string.format.

• ... (any) – parameters for message formatting.

warning(self, msg: string, ...: any)

Print a warning message.

Parameters:

• msg (string) – message format string, will be processed by string.format.

• ... (any) – parameters for message formatting.

error(self, msg: string, ...: any)

Print an error message.

Parameters:

• msg (string) – message format string, will be processed by string.format.

• ... (any) – parameters for message formatting.

Enum

enum logging.Level

Represents message severity.

Debug: integer

For debug messages, hidden by default.

Info: integer

For info messages.

Warning: integer

For warnings, when behavior may be different from what users expect.

Error: integer

For errors, when the system stops working.