Hello everyone again.

Ok, first, I don't like fights at all, everyone has its own opinion and can give its own advices, so the person that asked for help chose the one he wants and understand, it does not matter if it is difficult or not, efficient or inefficient, slow or faster. The person that asked for help would know its needs and will choose the method that better suits its problem.

The main objective is to share information, not to point out what is good and what is bad as if there was only one way to solve something. Point out PROs and CONs, I think is a better approach.

In any case, I really appreciate all the comments in this thread.

Put all previous aside, let me clarify some things:

1- I have used Doxygen before, since I could reproduce some old C++ projects I did in the past under a Linux environment. So, I have a little experience using Doxygen, but I cannot say I'm expert or that is easy or me to use it or configure it, since I mostly used the defaults with some little tweaks. But I do know I need to install the program and need an executable on Windows. I don't know what happened, but I thought I mentioned in my first comment, what makes me think that there is a long way to walk before I can express myself correctly. :-)

2- I forgot to add the original Perl-Filter syntax when I listed the syntax variations I used:

#** @method public int mult (int x, int y) # @brief Multiply two number. # @param x Factor 1. # @param y Factor 2. # @retval Multiplication #*

And not even like this I couldn't manage it to work.

GrandFather, I do get the doxyfile from the .tar.gz file, I used 7zip program to "untarted" and "unhizipped" or simply extract the files twice to have Doxygen-Filter-Perl directory. You'll find the doxyfile in Doxygen-Filter-Perl directory, the same directory where you use perl MakeFile.pl, nmake test and nmake install. I wrote nmake because I have Visual C++ compiler.

Now, doxygen Doxyfile did not work for my project using the commenting variations I mentioned. But, after reading a anonymous comment, I started playing with Perl.pm, and wonderful!! the filter worked with the doxyfile in the tar.gz and some minor changes in the doxyfile as Bret pointed out (I did those changes since the beginning of this thread).

Because Perl.PM is similar to the Perl files I need to create a documentation from, I took out some lines that my files don't have:

use 5.8.8; use strict; use warnings; use parent qw(Doxygen::Filter); use Log::Log4perl; use Pod::POM; use Doxygen::Filter::Perl::POD;

and now the all the generated documentation does not work, the only thing that got generated was the description of the file, there is no documentation for the subroutines.

So, my question, does this means that the only way Filter-Perl work is if a have I package statement?

As GrandFather asked me for a test case, well, now I have something more tangible:

With Doxygen installed, in the following path you can see an example of what I want to accomplish:

C:\Program Files\doxygen\examples\structcmd

to which I want to add the feature of the documentation of Perl.pm generated with Filter-Perl. That is the possibility of seeing the code of a subroutine with a click on "View code" link.

As always, I'll looking forward for comments.

Thanks.


In reply to Re: Doxygen Perl Filter on Windows by BAJA
in thread Doxygen Perl Filter on Windows by BAJA

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.