How to keep Documentation close to the Method using POD?

  • Thread starter Ilias Lazaridis
  • Start date
I

Ilias Lazaridis

I've written some perl modules.

I've documented the methods mostly in that way:

{{{
#!perl
sub methodName { my ($parm1, $param2) = @_;
# Short one line description of what this method does
}}}

How can I reuse this whilst using POD? e.g. with a tag of the kind

{{{
#!perl
sub methodName { my ($parm1, $param2) = @_;
=func Short one line description of what this method does
}}}

It looks like POD needs to have the documentation all at one point.

Can I use POD with the requirement "Keep documentation close to the
documented Entity (Module, Method, Parameter, ...)"?

http://dev.lazaridis.com/lang/ticket/12

..
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

Forum statistics

Threads
473,755
Messages
2,569,537
Members
45,020
Latest member
GenesisGai

Latest Threads

Top