file2doxygen.awk File Reference

This is a doxygen filter for unsupported scripting languages. More...

Functions
void	filter13 ()
	Initialise file documentation. More...
void	filter22 ()
	Print file documentation. More...
void	filter31 ()
	Mark the end of the documentation block. More...

Detailed Description

This is a doxygen filter for unsupported scripting languages.

It's pupose is to at least produce file documentation for those languages, as such it simply provides the file documentation at the beginning of a script (the comment after the shebang).

Function Documentation

filter13()

void filter13

(

)

Initialise file documentation.

Precondition

!doc && /^#!/  

filter22()

void filter22

(

)

Print file documentation.

Precondition

doc && /^#/  

filter31()

void filter31

(

)

Mark the end of the documentation block.

Precondition

doc