Beefy Boxes and Bandwidth Generously Provided by pair Networks
Come for the quick hacks, stay for the epiphanies.
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
I also installed this module on my Windows machine.

I will say that you are right in that this is a confusing mess and the directions were not at all clear to me as a non-Doxygen user! I don't think the problem is Windows...it is the limitations and capabilities of the Perl-filter?

Let's back up a bit...You are asking about Doxygen, but what you want is listing of function/method/subroutine(s) in a bunch of Perl modules which don't already have any documentation about these things.

I'm not sure that Doxygen will do what you want. Maybe there is another way to do it? I am hoping some other Monks can enlighten us. Perl is an amazingly introspective language and there may be a way to do what you want in a different way.

I ran doxygen-filter-perl on a simple .pl file. It looks like the goal of this thing is to produce "C/C++" pseudo statements that the Doxygen engine can then parse. I didn't install the complete (and apparently separate Doxygen program).

There is some guess-work here, but it looks like in the best case this thing will run your code and log the functions it calls? That's a different question than what are all of the functions in the source code (may be more than are called).

I have my doubts that this thing or anything for that matter can produce something as clear as a well written C declaration from Perl code - and even that might not be all that clear if all you have are the types and names.

I mean you may have to get down to having to manually write text in the form of comments about what each function does, expects and returns. Entropy is working in the wrong direction here. Perl - especially poorly written Perl - can be very cryptic even to a human versed in the art.

Example: "use" becomes "#include":

C:\TEMP>doxygen-filter-perl wxdata.pl /** @file wxdata.pl @version 1.00 */ #include "HTTP/Request/Common.pm" #include "LWP/UserAgent.pm" #include "constant.pm" #include "constant.pm" #include "constant.pm"

In reply to Re: Doxygen Perl Filter on Windows by Marshall
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":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others meditating upon the Monastery: (5)
As of 2024-04-23 11:11 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found