Good suggestions all. OTOH---I can't help but think that it wouldn't hurt to have a few more documentation tools, for both old and new authors. I'm working on a script using B::Deparse that will when done at least generate a skeleton document framework for subs and globals.
--hsm > -----Original Message----- > From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] > On Behalf Of Simon Cozens > Sent: Monday, August 16, 2004 4:39 AM > To: [EMAIL PROTECTED] > Subject: Re: Where do people learn how to document a module? > > [EMAIL PROTECTED] (Khemir Nadim) writes: > > It seems to me that few documents describe what to put in a > documentation or > > in which form. I haven't found any inteligent or complete description on > > CPAN. > > How to document a module: > 1) Look at modules you think are good examples of documentation. > 2) Copy their documentation. > 3) Edit. > > -- > We use Linux for all our mission-critical applications. Having the source > code > means that we are not held hostage by anyone's support department. > (Russell Nelson, President of Crynwr Software)
