Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 907 Bytes

Readme.md

File metadata and controls

32 lines (21 loc) · 907 Bytes

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

  • Comment procedure files using doxygen commands
  • Tweak doxygen config file and define at least
FILE_PATTERNS   = *.ipf
FILTER_PATTERNS = "*.ipf=gawk -f doxygen-filter-ipf.awk"

Alternatively you can use the supplied example Doxyfile.

  • Execute doxygen

An example of the result can be seen here.

Missing features

  • Igor help file generation
  • Function subtype support