Doxygen Namespace Reference

The Doxygen namespace was created for modules used to parse source files as Doxygen input filters. More...

Namespaces
namespace	Item
namespace	Perl
namespace	POD
namespace	Script
Classes
class	Filter
	Base class for Doxygen filter classes. More...
class	Item
	Perl extension for generating Doxygen documentation. More...
class	Source
	Perl extension for generating Doxygen documentation. More...
class	Test
	Test module, used only in Doxygen:: test files (.t files). More...

---

Detailed Description

The Doxygen namespace was created for modules used to parse source files as Doxygen input filters.

We did not want to make this a sub-namespace of POD (e.g. C<POD::Doxygen>) because these modules can be used on files other than POD. For example, we include filters for shell scripts and DOS/Windows batch files.

We intend to build a filter for SQL as well. And there is no reason why the architecture we've created couldn't be used to handle other languages such as Ruby or JavaScript.

This may seem like hubris, since after all users of those other programming languages would naturally want to create their own tools in their own favorite languages, of course. We don't need no stinking Perl!

We've noticed, however, that Perl shows up a lot on the Doxygen tools page. It looks like a lot of other languages are processed for Doxygen by Perl code even though there has to date not been a good solution for Perl code. Snicker. ;)