Velocity Reviews - Computer Hardware Reviews

Velocity Reviews > Newsgroups > Programming > Perl > Perl Misc > How to keep Documentation close to the Method using POD?

Reply
Thread Tools

How to keep Documentation close to the Method using POD?

 
 
Ilias Lazaridis
Guest
Posts: n/a
 
      06-08-2007
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

..

 
Reply With Quote
 
 
 
 
Ilias Lazaridis
Guest
Posts: n/a
 
      06-09-2007
On Jun 8, 1:45 pm, Ilias Lazaridis <i...@lazaridis.com> wrote:

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


I've found this perl module, which seems to have the flexibility to
handle cases like the above:

http://perl.overmeer.net/oodoc/

has anyone experiences with OODoc?

..

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

 
Reply With Quote
 
 
 
Reply

Thread Tools

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
Re: How include a large array? Edward A. Falk C Programming 1 04-04-2013 08:07 PM
How to close a TCP socket? (TCPSocket#close doesn't close it) Iñaki Baz Castillo Ruby 7 01-12-2010 01:32 PM
perform an action when we close the window using the close tab at the top of the screen tapanreddy@gmail.com Javascript 4 04-10-2007 09:37 PM
close current window using window.close() Shang Wenbin Javascript 10 09-02-2005 12:16 AM
JavaMail POP3 folder.close() method close also store! Daniel Albisser Java 1 04-07-2004 03:45 PM



Advertisments
 



1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57