[Mageia-dev] Suggest summary documentation of Mageia perl routines

Buchan Milne bgmilne at staff.telkomsa.net
Wed Aug 24 09:24:40 CEST 2011

On Wednesday, 24 August 2011 08:31:51 andre999 wrote:
> Thierry Vignaud a écrit :
> > On 23 August 2011 15:46, Jerome Quelin<jquelin at gmail.com>  wrote:
> >> On 11/08/23 15:40 +0200, Thierry Vignaud wrote:
> >>> Which one jquelin is reffering to?
> >> 
> >> none. i'm maintaining perl&  perl modules for mageia, but am not a drak*
> >> contributor.
> > 
> > OK, I was mistaken by "a post by jquelin reminded me of something that
> > would be nice to see"
> my fault ... a comment he made about something unrelated reminded me of
> this idea. I've been wanting to contribute to drak* for some time.
> (but readily distracted by other things)
> Something like :
> ----
> routine: foo(parm1, parm2, ...)
> path: .../{filename}
> purpose: ...
> parm1 = ...
> parm2 = ...
> ----
>   for each routine, without any details of internals.
> (Essentially, what does the black box do.)
> The path is useful if more than one function has the same name, as well as
> examining internals if wanted.
> Basically I was thinking of Mageia-specific perl routines.
> I started deciphering rpmdrake back on mdv, and did a cludge to rearrange
> the main screen, but not being familiar with the invoked routines was a
> big handicap for doing more.
> You gave me some useful tips at the time.
> I could make a script to extract the routine names + paths, but at least
> one line of comment in the perl code right after the routine name would be
> very useful.  (It could be just before - but that would be harder to
> extract.)

Please use POD for this, the perldoc tool can extract it, no need to write 
something to do it. The POD can be interleaved with the code (so it can be 
both the comment and the documentation).

Of course, it might also be an idea to refactor libDrakX (use a unique 
namespace etc.).



More information about the Mageia-dev mailing list