?
Solved

Documentation aid similar to JavaDoc

Posted on 2003-03-14
6
Medium Priority
?
236 Views
Last Modified: 2008-02-26
I am sure I have seen something like JavaDoc for perl. I looked on SourceForge and there is a perldoc project but it is inactive and has no files.

Does anyone know of a tool that will give me the ability to document my perl classes in a similar way as JavaDoc does?

Regards
ICD
0
Comment
Question by:icd
[X]
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions
6 Comments
 
LVL 48

Expert Comment

by:Tintin
ID: 8139655
I'm not that familar with Javadoc, but I'm pretty sure it's similar to POD (Plain Old Documentation).

Type in:

perldoc perlpod

To read more details

or see http://www.perldoc.com/perl5.8.0/pod/perlpod.html
0
 
LVL 5

Author Comment

by:icd
ID: 8140078
I have seen POD, the advantage of JavaDoc is that it creates a set of web pages with frame navigation to drill down all of the class methods. I have also seen a version for PHP called PhpDoc. I was hoping for something similar for Perl.
0
 
LVL 48

Expert Comment

by:Tintin
ID: 8140100
You can convert POD into a number of different formats, eg: HTML, PS etc.  However, I'm not aware of any tool that allows frame navigation apart from the Perl documentation set that comes with ActiveState Perl.
0
Independent Software Vendors: We Want Your Opinion

We value your feedback.

Take our survey and automatically be enter to win anyone of the following:
Yeti Cooler, Amazon eGift Card, and Movie eGift Card!

 
LVL 5

Author Comment

by:icd
ID: 8237502
there seems to be no answer to this question so I have implemented a manual documentation aid directly in HTML.
0
 
LVL 20

Expert Comment

by:jmcg
ID: 9698926
Nothing has happened on this question in over 7 months. It's time for cleanup!

My recommendation, which I will post in the Cleanup topic area, is to
PAQ, refund points (asker provided their own solution, of sorts, but responses may be considered useful).

Please post any comments here within the next seven days.

PLEASE DO NOT ACCEPT THIS COMMENT AS AN ANSWER!

jmcg
EE Cleanup Volunteer
0
 
LVL 1

Accepted Solution

by:
Computer101 earned 0 total points
ID: 9745088
PAQed, with points refunded (125)

Computer101
E-E Admin
0

Featured Post

Free Tool: Port Scanner

Check which ports are open to the outside world. Helps make sure that your firewall rules are working as intended.

One of a set of tools we are providing to everyone as a way of saying thank you for being a part of the community.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Email validation in proper way is  very important validation required in any web pages. This code is self explainable except that Regular Expression which I used for pattern matching. I originally published as a thread on my website : http://www…
I have been pestered over the years to produce and distribute regular data extracts, and often the request have explicitly requested the data be emailed as an Excel attachement; specifically Excel, as it appears: CSV files confuse (no Red or Green h…
Explain concepts important to validation of email addresses with regular expressions. Applies to most languages/tools that uses regular expressions. Consider email address RFCs: Look at HTML5 form input element (with type=email) regex pattern: T…
Six Sigma Control Plans

801 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question