Doxygen Perl Filter on Windows

[BAJA]

Hi,

I started a thread of this subject on Perl Monks, here is the link if you want to read it:
http://www.perlmonks.org/?node_id=945151

I have a task to do which is to document a bunch of .pl files that are about two to four hundred lines each. They have no structure whatsoever, they are just a compilation of subroutines/methods/functions. The people that normally use this files they use CTRL+F to search for an specific subroutine.

So at least I want to provide a documentation with a nice list of subroutines done with Doxygen.

The idea is to make a listing as the one in the following path where Doxygen is installed:

..\doxygen\examples\structcmd\html

and adding to it a nice feature that Doxygen Perl Filter documentation have: a "view code" link for each subroutine. To have a documentation of the filter you can follow the procedure below, that was the last thing Bret asked to do in the PerlMonks' thread.

Bret, here are the comments to what you asked me to do:

Baja,

I would like to understand what does not work for you so that I can either fix it in code or fix the documentation. Since I do not run windows, I am linux and Mac OSX, I can not try this myself. But I would like you to try this for me:

1) You have doxygen installed and doxygen.exe is in your path.
Uninstalled and did a fresg installation. Comfirmed that Doxygen is the PATH environmental variable.

2) Download Doxygen-Filter-Perl-1.00.tar.gz to c:\temp\ from http://sourceforge.net/projects/perldoxygen/files/

3) Extract Doxygen-Filter-Perl-1.00.tar.gz to c:\temp\Doxygen-Filter-Perl-1.00\ with your 7zip or the tar/gzip tools for windows from http://unxutils.sourceforge.net/
2) and 3) I downloaded and extract Doxygen Perfl Filter December 22nd version.

4) cd to c:\temp\Doxygen-Filter-Perl-1.00\

5) So while you are in this directory edit the Doxyfile to change the location of the doxygen-filter-perl script to where ever you have it, or to use the one in c:\temp\Doxygen-Filter-Perl-1.00\bin\ I change FILTER value of the Doxyfle to C:\temp\Doxygen-Filter-Perl-1.00\bin\

6) From c:\temp\Doxygen-Filter-Perl-1.00\ run "doxygen.exe Doxyfile" This should create a directory called doc\html\ here: c:\temp\Doxygen-Filter-Perl-1.00\doc\html\ Now inside the html directory there will be an index.html. You should be able to open that and see the output of using Doxygen::Filter::Perl against itself. Thus see the internal documentation for Doxygen::Filter::Perl.

Please let me know if that works for you. If that does, then we can start looking at why this does not work for your .pl file.
Bret

At the end I couldn't get the internal DoxygenFilterPerl documentation with FILTER pointing to c:\temp\Doxygen-Filter-Perl-1.00\bin\ , so I change the FILTER path in the doxyfile to C:/Perl/site/bin/, this is because I have already done:
perl Makefile.PL
make
make install

I don't know if you want me to install this lastest version or to uninstall the first one in which case I don't know how to.

[BAJA]

#** @file Characterization.pl
#   @brief This Include file has Sub routines that can be use for             Characterization.
#    
#   Date        : Who                       : Description
#   ------------------------------------------------------------------------
#   8/12/2011   : XXXXXXXXXXXX              : Initial creation
#*

#** @method WaitCharStudio()
#   @brief Waits till Characterization Studio loads up.
#   
#*
sub WaitCharStudio
{
    &WaitCpu( "CharacterizationStudio" );
}

#** @method MaximizeChar()
#   @brief Maximize Characterization Studio window.
#   
#*
sub MaximizeChar
{

my @Handle = FindWindowLike(undef, "^Characterization Studio");
$Char = $Handle [0];
if($Char)
{
    SetForegroundWindow($Char);
    &MoveWindow($Char, 1, 0, 0, 1024, 768, 4);
    sleep 2;
    return "true";
}
else
{
    return "false";
}

}

Hi Bret, most of the file have an structure like this one.
I know the word Charaterization in line 3 is not commented but that´s because the sentence is too long. but it is on the actual file, still I don't get any documentation out of this.

What would you think I'm doing wrong?