http://qs321.pair.com?node_id=332434

kgimpel has asked for the wisdom of the Perl Monks concerning the following question:

I am working with a code written in at least three different languages. Two of these are parsed quite well by the inline documentaition/call-graph engine called doxygen (which seems to parse c-like code fairly well). I'd like to use doxygen for the perl components too, so all my docs can be managed in a single place.

Natively, the perl code isn't parsed well but I think with some serious munging the perl code could be made to look more c-like. The temporary, munged file would not have to actually be functional, just look like it to a c parser.

Has anyone already solved this problem in another context?

I'm sure the authors of doxygen would love to include a solution as a new helper. (hint hint) I'd love to take a crack at it, but it may be some time before I will be able to work on it.

Replies are listed 'Best First'.
Re: perl plugin for doxygen
by PodMaster (Abbot) on Feb 28, 2004 at 09:29 UTC
    Perl is not C or C++ or Java (no function prototypes/signatures), so you can't really write a plugin for doxygen, at least not a very good one. Well, you can, given your code conforms to one style, but if you're going to do that, you might as well use OODoc or ePod instead.

    I myself like to use Test::Pod::Coverage to make sure my public apis are documented with good ol pod :)

    Actually, I do recall that B::Xref could be very very handy to accomplish something doxyish ... i think i'll suggest that gmpassos and markov consider employing those in their respective thingamajiggers, maybe :)

    MJD says "you can't just make shit up and expect the computer to know what you mean, retardo!"
    I run a Win32 PPM repository for perl 5.6.x and 5.8.x -- I take requests (README).
    ** The third rule of perl club is a statement of fact: pod is sexy.

[reply]

Back to Seekers of Perl Wisdom