filter.sugar.awk File Reference

Filter certain syntactical sugar from C code. More...

Functions
void	filter10 ()
	Remove indented preprocessor instructions, they are usually just in place hacks that don't need to show up in the docs. More...
void	filter15 ()
	Detect the beginning of a documentation block. More...
void	filter20 ()
	Detect the end of a documentation block. More...
void	filter26 ()
	Align documentation so verbatim and code sections are formatted correctly. More...
void	filter31 ()
	Print the updated line. More...

Detailed Description

Filter certain syntactical sugar from C code.

Function Documentation

filter10()

void filter10

(

)

Remove indented preprocessor instructions, they are usually just in place hacks that don't need to show up in the docs.

Precondition

/^[ \t]+#/  

filter15()

void filter15

(

)

Detect the beginning of a documentation block.

Precondition

/\/\*\*/  

filter20()

void filter20

(

)

Detect the end of a documentation block.

Precondition

/\*\//  

filter26()

void filter26

(

)

Align documentation so verbatim and code sections are formatted correctly.

Precondition

comment  

filter31()

void filter31

(

)

Print the updated line.

Precondition

1