Doxypractice

Doxypractice is a language filter for Doxygen 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
• Doxygen
• Python Tree-sitter
• tree-sitter-t32

Installation

Use the package manager pip to install Doxypractice.

pip install lauterbach-trace32-doxypractice

Usage

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

doxypractice <script>

Doxygen Integration

To integrate Doxypractice with Doxygen, update your Doxyfile¹ as follows:

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

Create the project documentation:

doxygen Doxyfile

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