doxygen-filter-perl  1.73-2
About: PerlDoxygen is an input pre-filter for Doxygen enabling support for Perl code documentation.
  Fossies Dox: doxygen-filter-perl-1.73-2.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

doxygen-filter-perl Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies doxygen-filter-perl-1.73-2.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).




The major features of Doxygen::Filter::Perl are as follows:
    Support for Doxygen style comments in Perl
    Ability to convert POD comments in to Doxygen format


To install this module type the following:
perl Makefile.PL
make test
make install

Copy the Doxyfile doxygen config file out of this project and put it in the base of your project.  You 
will want to update at least the following fields in that Doxfile to match your project:


This module requires these other modules and libraries:
Pod::POM (0.29)                 [License = Perl]
Pod::POM::View::HTML (1.06)     [License = Perl]
Log::Log4perl (1.46)            [License = Perl]
Test::More (1.001014)           [License = Perl]
Test::Output (1.03)             [License = Perl]
IO::Handle (1.34)


This is free software, licensed under the Apache License, Version 2.0. See the LICENSE file included with this package for license details.


Bret Jordan, jordan2175 at Google's mail system littledot com

Copyright (C) 2011 by Bret Jordan all rights reserved