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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<TITLE> [Mageia-dev] Suggest summary documentation of Mageia perl routines
</TITLE>
<LINK REL="Index" HREF="index.html" >
<LINK REL="made" HREF="mailto:mageia-dev%40mageia.org?Subject=Re%3A%20%5BMageia-dev%5D%0A%20%3D%3Futf-8%3Fq%3FSuggest_summary_documentation_of_Mageia_pe%3F%3D%0A%20%3D%3Futf-8%3Fq%3Frl%3D09routines%3F%3D&In-Reply-To=%3C201108240924.43411.bgmilne%40staff.telkomsa.net%3E">
<META NAME="robots" CONTENT="index,nofollow">
<META http-equiv="Content-Type" content="text/html; charset=us-ascii">
<LINK REL="Previous" HREF="007477.html">
<LINK REL="Next" HREF="007486.html">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H1>[Mageia-dev] Suggest summary documentation of Mageia perl routines</H1>
<B>Buchan Milne</B>
<A HREF="mailto:mageia-dev%40mageia.org?Subject=Re%3A%20%5BMageia-dev%5D%0A%20%3D%3Futf-8%3Fq%3FSuggest_summary_documentation_of_Mageia_pe%3F%3D%0A%20%3D%3Futf-8%3Fq%3Frl%3D09routines%3F%3D&In-Reply-To=%3C201108240924.43411.bgmilne%40staff.telkomsa.net%3E"
TITLE="[Mageia-dev] Suggest summary documentation of Mageia perl routines">bgmilne at staff.telkomsa.net
</A><BR>
<I>Wed Aug 24 09:24:40 CEST 2011</I>
<P><UL>
<LI>Previous message: <A HREF="007477.html">[Mageia-dev] Suggest summary documentation of Mageia perl routines
</A></li>
<LI>Next message: <A HREF="007486.html">[Mageia-dev] Suggest summary documentation of Mageia perl routines
</A></li>
<LI> <B>Messages sorted by:</B>
<a href="date.html#7482">[ date ]</a>
<a href="thread.html#7482">[ thread ]</a>
<a href="subject.html#7482">[ subject ]</a>
<a href="author.html#7482">[ author ]</a>
</LI>
</UL>
<HR>
<!--beginarticle-->
<PRE>On Wednesday, 24 August 2011 08:31:51 andre999 wrote:
><i> Thierry Vignaud a écrit :
</I>><i> > On 23 August 2011 15:46, Jerome Quelin<<A HREF="https://www.mageia.org/mailman/listinfo/mageia-dev">jquelin at gmail.com</A>> wrote:
</I>><i> >> On 11/08/23 15:40 +0200, Thierry Vignaud wrote:
</I>><i> >>> Which one jquelin is reffering to?
</I>><i> >>
</I>><i> >> none. i'm maintaining perl& perl modules for mageia, but am not a drak*
</I>><i> >> contributor.
</I>><i> >
</I>><i> > OK, I was mistaken by "a post by jquelin reminded me of something that
</I>><i> > would be nice to see"
</I>><i>
</I>><i> my fault ... a comment he made about something unrelated reminded me of
</I>><i> this idea. I've been wanting to contribute to drak* for some time.
</I>><i> (but readily distracted by other things)
</I>><i>
</I>><i> Something like :
</I>><i> ----
</I>><i> routine: foo(parm1, parm2, ...)
</I>><i> path: .../{filename}
</I>><i> purpose: ...
</I>><i> parm1 = ...
</I>><i> parm2 = ...
</I>><i> ----
</I>><i> for each routine, without any details of internals.
</I>><i> (Essentially, what does the black box do.)
</I>><i> The path is useful if more than one function has the same name, as well as
</I>><i> examining internals if wanted.
</I>><i>
</I>><i> Basically I was thinking of Mageia-specific perl routines.
</I>><i> I started deciphering rpmdrake back on mdv, and did a cludge to rearrange
</I>><i> the main screen, but not being familiar with the invoked routines was a
</I>><i> big handicap for doing more.
</I>><i> You gave me some useful tips at the time.
</I>><i>
</I>><i> I could make a script to extract the routine names + paths, but at least
</I>><i> one line of comment in the perl code right after the routine name would be
</I>><i> very useful. (It could be just before - but that would be harder to
</I>><i> extract.)
</I>
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.).
Regards,
Buchan
Regards,
Buchan
</PRE>
<!--endarticle-->
<HR>
<P><UL>
<!--threads-->
<LI>Previous message: <A HREF="007477.html">[Mageia-dev] Suggest summary documentation of Mageia perl routines
</A></li>
<LI>Next message: <A HREF="007486.html">[Mageia-dev] Suggest summary documentation of Mageia perl routines
</A></li>
<LI> <B>Messages sorted by:</B>
<a href="date.html#7482">[ date ]</a>
<a href="thread.html#7482">[ thread ]</a>
<a href="subject.html#7482">[ subject ]</a>
<a href="author.html#7482">[ author ]</a>
</LI>
</UL>
<hr>
<a href="https://www.mageia.org/mailman/listinfo/mageia-dev">More information about the Mageia-dev
mailing list</a><br>
</body></html>
|
