Metadata-Version: 2.4
Name: lauterbach-trace32-doxypractice
Version: 1.0.0
Summary: Doxygen Filter for Lauterbach TRACE32 Scripts
Author-email: Lauterbach GmbH <support@lauterbach.com>
Maintainer-email: Lauterbach GmbH <support@lauterbach.com>
License-Expression: MIT
Project-URL: Homepage, https://www.lauterbach.com
Project-URL: Repository, https://gitlab.com/lauterbach/doxypractice
Project-URL: Issues, https://support.lauterbach.com/
Project-URL: Changelog, https://gitlab.com/lauterbach/doxypractice/CHANGELOG.md
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Debuggers
Classifier: Intended Audience :: Developers
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSES/MIT.txt
Requires-Dist: chardet>=5.2.0
Requires-Dist: tree-sitter>=v0.25.0
Requires-Dist: tree-sitter-t32>=5.5.0
Provides-Extra: dev
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: types-setuptools; extra == "dev"
Provides-Extra: test
Requires-Dist: coverage; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-mock; extra == "test"
Dynamic: license-file

# Doxypractice

**Doxypractice** is a language filter for [Doxygen](https://www.doxygen.nl) that adds support for Lauterbach TRACE32 scripts.
It translates TRACE32 scripts into a C-like format that is understood by Doxygen.

## Quick Start

### Dependencies

Python version 3.10 or higher is required.

- [chardet](https://github.com/chardet/chardet)
- [Doxygen](https://www.doxygen.nl)
- [Python Tree-sitter](https://github.com/tree-sitter/py-tree-sitter)
- [tree-sitter-t32](https://codeberg.org/xasc/tree-sitter-t32)

### Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install Doxypractice.

```bash
pip install doxypractice
```

### Usage

Doxypractice is a console script that expects the path to a PRACTICE file as only input argument:

```bash
doxypractice <script>
```

### Doxygen Integration

To integrate Doxypractice with Doxygen, update your `Doxyfile`[^1] as follows:

```ini
EXTENSION_MAPPING   = cmm=C++
FILTER_PATTERNS     = *.cmm=doxypractice
FILE_PATTERNS       = *.cmm
FILTER_SOURCE_FILES = YES
INLINE_SOURCES      = YES
```

Create the project documentation:

```bash
doxygen Doxyfile
```

> [!NOTE]
> Make sure Doxypractice is installed and in `PATH`.

[^1]: https://www.doxygen.nl/manual/starting.html#step1
