Skip to main content

Doxygen Filter for Lauterbach TRACE32 Scripts

Project description

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.

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^1 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lauterbach_trace32_doxypractice-1.1.0.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file lauterbach_trace32_doxypractice-1.1.0.tar.gz.

File metadata

File hashes

Hashes for lauterbach_trace32_doxypractice-1.1.0.tar.gz
Algorithm Hash digest
SHA256 4ce9809cf5d12aa280444e9969886b45daabb43785ac970c7bc144cc4240184d
MD5 fbb14b988f7ba11b74ff45d95480220e
BLAKE2b-256 a3ba78048fac45cee60471dd3788a5fd42f65c58a5bfcf9f1b47f5401c0bac5a

See more details on using hashes here.

File details

Details for the file lauterbach_trace32_doxypractice-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for lauterbach_trace32_doxypractice-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8cec7258814802234e37974827e4321be14c33e05d6947034d0ac2ad6a29e97c
MD5 f580e3c7aa3e44f34808f3e71ac181c0
BLAKE2b-256 3bfd543b7337448edfd6e238c6a451128a7197de6508119d68a655c787597a44

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page