Advanced Installation

Vsevolod Kukol edited this page Feb 3, 2015 · 1 revision

#Advanced Installation

The VB filter can be installed anywhere you like and be used in an automatic build hook for example.

The next steps describe a system wide installation.

##Windows ###Step 1: Prerequisites

Download and install Doxygen and optionally GraphViz. Both setups set the PATH environment variable correctly, so you can run the binaries from everywhere on the command line.

Download the Gawk binary or setup package from http://gnuwin32.sourceforge.net/packages/gawk.htm You may want to add gawk.exe to your path, too. Simply copy gawk.exe to C:\Windows\gawk.exe, or add the executable path to your PATH environment variable.

###Step 2: Unpack vbfilter.awk

Download the VB filter zip/tarball from the Releases page and extract vbfilter.awk to a directory without whitespaces.

Alternatively you can checkout the current development version using git checkout https://github.com/sevoku/doxygen-vb-filter.git some\path

Good places could be:

c:\vbfilter\vbfilter.awk
c:\ProgramData\vbfilter\vbfilter.awk 

##Linux ###Step 1: Prerequisites

Download and install Doxygen and optionally GraphViz. Make sure that the binaries are installed in your PATH so you can run them directly (check with which doxygen; which dot).

Make sure you have gawk installed.

###Step 2: Unpack vbfilter.awk

Download the VB filter zip/tarball from the Releases page and extract vbfilter.awk.

Alternatively you can checkout the current development version using git checkout https://github.com/sevoku/doxygen-vb-filter.git some\path

Good places for the script could be:

/var/lib/vbfilter/vbfilter.awk
/usr/local/share/vbfilter/vbfilter.awk 

#Wrapper script

If you have different source types in your solution and want to use the FILTER_PATTERNS option, or if you have many Doxyfiles and don't want to bother about paths, you should create a wrapper script.

A wrapper script simply runs gawk with the "-f" parameter. It's only a workaround, because Doxygen has problems with launching a filter binary with additional parameters, if FILTER_PATTERNS Doxyfile option is used.

##Windows

Create a new Batch file in the vbfilter or Windows folder with the following content:

@echo off
C:\vbfilter\gawk.exe -f C:\vbfilter\vbfilter.awk "%1%"

You can find an example script on GitHub: https://github.com/sevoku/doxygen-vb-filter/blob/master/vbfilter.bat

Change the paths accordingly to your system! Additionally you should add the path of the script to your PATH environment variable.

Now you can simply set

INPUT_FILTER           = vbfilter.bat

or

FILTER_PATTERNS        = *.vb=vbfilter.bat

in your Doxyfiles.

##Linux

create a new shell script, named vbfilter.sh, in your path (/usr/local/bin/vbfilter.sh for example):

#/!bin/sh
gawk -f /var/lib/vbfilter/vbfilter.awk "$1"

You can find an example script on GitHub: https://github.com/sevoku/doxygen-vb-filter/blob/master/vbfilter.sh

Don't forget to make the script executable:

chmod +x /usr/local/bin/vbfilter.sh

Now you can simply set

INPUT_FILTER           = vbfilter.sh

or

FILTER_PATTERNS        = *.vb=vbfilter.sh

in your Doxyfiles.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.