Skip to content
Vsevolod Kukol edited this page Feb 3, 2015 · 8 revisions

What is the Visual Basic Filter for Doxygen?

The Doxygen Visual Basic filter is an awk script that converts Classic VB and VB.NET code syntax to a C#-like syntax, so it can be read and understood by Doxygen.

It is inspired by the Visual Basic (classic) filter script written by Mathias Henze. More information about his script can be found in the Helper Tools section on the Doxygen homepage.

##How does it work

Doxygen can preprocess all sources using a source filter. A source filter must be executable, accept the name of the source path as last parameter and print the resulting source to STDOUT. See the Doxygen manual for more information.

The vbfilter.awk script is a AWK script, which can be executed using gawk. Gawk reads the source files line by line, applies vbfilter.awk on it and passes the output to doxygen.

##Documentation

  1. Features and Limitations
  2. Requirements
  3. Environment Setup
  4. Filter configuration
  5. Documenting your sources
  6. Generating Documentation
  7. Advanced Installation

##Credits

Thanks got to:

  • Dimitri van Heesch for the wonderful documentation system Doxygen
  • Mathias Henze for the inspiration for my work
  • Mangala Sadhu Sangeet Singh for fixing apostrophe handling
  • Patrick Kursawe for adding nested classes support and overall optimization of the parser

##License

Copyright © 2010-2015 by Vsevolod Kukol (sevo (at) sevo (dot) org)

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.