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 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.0.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.0.0.tar.gz.

File metadata

File hashes

Hashes for lauterbach_trace32_doxypractice-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9d88c9a39bfa7c9e51836c6fc6acd079696a855bd5d3a169c60c1c1b56400909
MD5 526dd15b7b28586c411699cd7ebbe5cc
BLAKE2b-256 9cbbd7fd6133d836a8374c38dae503f2f2fc00a5662a63b9594220d41f397f98

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lauterbach_trace32_doxypractice-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 683512189f2cab31539398a89dad2f478a51101c5e730338f0ae546a35c0c09c
MD5 e282b1bb4f4627dbd3b30d7f57993bdd
BLAKE2b-256 480d2d975394fc6fa5a4ea68f33938a07c4608d99904de3dca14d2a221b7a00b

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