Filter configuration (original) (raw)

#Configuring the VB Filter There are several useful options inside vbfilter.awk.

Open it with your favorite editor and scroll down to the configuration section:

#############################################################################
# Configuration
#############################################################################
# unix line breaks
# set to 1 if using doxygen on unix with
# windows formatted sources
UnixLineBreaks=1;

# leading shift inside classes/namespaces/etc.
# default is "\t" (tab)
ShiftRight="\t";
#ShiftRight="    ";
        
# add namespace definition at the beginning using project directory name
# should be enabled, if no explicit namespaces are used in the sources
# but doxygen should recognize package names.
# in C# unlike in VB .NET a namespace must always be defined
leadingNamespace=1;

####UnixLineBreaks

If your sources are stored with default windows line breaks [CR+LF] (usually the case for VB files) and your doxygen installation is on Linux, then set this to 1.

On Windows this option has no effect.

####ShiftRight

This options sets the characters used for shifting. not really useful, but for debugging.

####leadingNamespace

This is useful, if you are not using Namespace directives in your sources. VB.NET uses then automatically the project name, but Doxygen doesn't support this.

If enabled, the filter adds a leading namespace , where ProjectName will be the subfolder containing the processed file.

Example:

' file header documentation ' Project name is LibTest ' File path: LibTest\test.vb ' ''' Class documentation Public Class Test End Class

will be converted to:

/**