i've been tasked with creating a documentation base for our (currently *undocumented* -- not even good comments or self-documenting code ) primary application. an easy thing to do (once i have a full handle on the code in all its intricacies and weaving around and ... ) and a good way to really know the guts of the application.

thing is, the PHB wants to have a 'searchable, web-enabled' documentation repository ( think something *like* cvsweb or doxygen )

for those that haven't seen doxygen, i found it when reading through the drupal CMS site. it's some form of documentation generator (at the very least, it generates HTML docs like javadoc).

i don't remember seeing anything like, say, doxygen or javadoc for perl. if there's such a thing out there, i'd love to use it and not re-invent a wheel. even for the 'learning experiene' on this one -- documenting the code should be my primary concern, not reinventing an HTML page generation app.

if there *isn't* something like these out there, i do think i'll see about getting on the doxygen team to make the doodad work with perl.

so, do the rest of you think there's an equivalent out there? or am i gonna jump into an open-source programming team?

---

---

• 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.