# Automatic documentation decorators

The `torx/decorators` module provides a set of decorators for automatic 
rich documentation in the TorX project. These decorators are designed 
to provide a nice documentation for modules, functions, and classes.

## Overview

The automatic rich documentation decorators are a set of tools that help 
you create high-quality documentation for your code. They are designed to 
be easy to use and flexible, allowing you to customize the documentation to 
fit your needs.

## Decorators

The decorators provided by the `torx/decorators` module are:

* `autodoc_module`: Automatically creates nice documentation for modules.
* `autodoc_function`: Automatically creates nice documentation for functions.
* `AutoDocClass`: Automatically creates nice documentation for classes.
* `AutoDocEnum`: Automatically creates nice documentation for enumerations.

## Usage

Here are some examples of how to use the decorators:

```python
from torx.decorators import autodoc_module
autodoc_module(__name__)
```

```python
from torx.decorators import AutoDocClass
class MyClass(AutoDocClass):
    pass
```

```python
from torx.decorators import autodoc_function
@autodoc_function
def my_function():
    pass
```

```python
from torx.decorators import AutoDocEnum
class MyEnum(AutoDocEnum):
    A = 1
    B = 2
```