Doxygen filter for procedure files

This project here is a proof of concept implementation in AWK of an filter which translates procedure files into C-ish output for doxygen consumption. Works with breathe and sphinx as well.

Requires GNU AWK. Available for windows here.

Supported Features

  • Functions, including parameter type resolution, call-by-reference recognition and optional parameters
  • Constants
  • Macros
Workflow


  1. Comment procedure files using doxygen commands
  2. Tweak doxygen config file and define at least (or use the supplied example Doxyfile)

    FILE_PATTERNS = *.ipf
    FILTER_PATTERNS = "*.ipf=gawk -f doxygen-filter-ipf.awk"

  3. Execute doxygen
An example of the result can be seen here.

Missing features

  • Igor help file generation
  • Function subtypes

Project Details

Project Homepage: View Homepage

Current Project Release

Doxygen filter for procedure files IGOR.6.00.x-0.28

Release File: doxIPFFilter-v0.28.zip
Version: IGOR.6.00.x-0.28
Version Date: Thu, 11/02/2017 - 09:22 am
Version Major: 0
Version Patch Level: 28
OS Compatibility: Mac-Intel Windows
Release Notes: - Add License
- Avoid false positives in function signature search
View All Releases

Forum

Support

Gallery

Igor Pro 8

Learn More

Igor XOP Toolkit

Learn More

Igor NIDAQ Tools MX

Learn More