Perl extension for generating Doxygen documentation. More...

Inheritance diagram for Doxygen::Script::Filter:

Public Member Functions
	parse ($text, $source)
	Parse a source file.

Detailed Description

Perl extension for generating Doxygen documentation.

SYNOPSIS

Generally this class will be instantiated:

  my  $filter = new Doxygen::Script::Filter($path);

and used within one of the other Doxygen:: internal classes.

The user will normally invoke this filter by aliasing and configuring it during an invocation of DoxyFilt.pl. DoxyFilt.pl takes useful default settings from the Doxygen::Source module.

By default, Doxygen::Source pre-configures both Windows batch files and *NIX shell scripts. The equivalent DoxyFilt.pl command-line arguments would be:

  DoxyFilt.pl --alias   Batch=Script
              --docs    Batch=qr(\.(?:bat|cmd)$)i
              --comment Batch=qr(^\s*rem ?(.*)$)im
              --alias   Shell=Script
              --docs    Shell=qr(\.(?:ba|c|k|z)?sh$)i
              --comment Shell=qr(^\s*#{2,3}(?!#) ?(.*)$)m
              --check   Shell=qr(^#!/bin/(?:ba|c|k|z)?sh\b)

allowing, of course, for the quoting of characters to get past the command-line interpreter and the fact that the current codebase probably doesn't handle the regular expression terminal qr()im flags (oops).

ABSTRACT

Simplistic filter for scripts, whether DOS/Windows batch files or *NIX shell scripts.

DESCRIPTION

Generates a Doxygen file comment block. Pulls out whatever comments are marked via the basic comment pattern mechanism supported by Doxygen::Source.

May at some point create a script group and mark therein.

COPYRIGHT AND LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Version:: '0.01'

Author:: Marc M. Adkins, mailTo:Perl@Doorways.org

Definition at line 79 of file Filter.pm.

Member Function Documentation

Doxygen::Script::Filter::parse	(	$	text,
		$	source
	)

Parse a source file.

Attach results (Doxygen::Item objects) to Doxygen::Source object.

Reimplemented from Doxygen::Filter.

The documentation for this class was generated from the following file:

Script/Filter/Filter.pm

DoxyFilt: Doxygen::Script::Filter Class Reference

Doxygen::Script::Filter Class Reference