ben 98/05/25 12:51:58
Modified: apidoc api.list mkapidict
Added: apidoc dict-ap_acquire_mutex.html
Log:
Add a small amount of documentation. Allow for multiple layout styles. Add a
much briefer style.
Revision Changes Path
1.4 +19 -3 apache-devsite/apidoc/api.list
Index: api.list
===================================================================
RCS file: /export/home/cvs/apache-devsite/apidoc/api.list,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- api.list 1998/05/20 18:34:14 1.3
+++ api.list 1998/05/25 19:51:57 1.4
@@ -1,4 +1,4 @@
-#;
+ #;
#; Metadata about API components. Each record contains several fields,
#; separated by vbars (|). Comments begin with '#;' and continue
#; to the end of the line. Leading whitespace is discarded except as
@@ -271,8 +271,8 @@
R|ap_acquire_mutex\
|int $*(mutex *mutex_id);\
|\
- |SA-mutex\
- |
+ |SA-mutex,MULTI_OK,MULTI_ERR,MULTI_TIMEOUT\
+ |dict-ap_acquire_mutex.html
R|ap_create_mutex\
|mutex *$*(char *name);\
|\
@@ -2699,6 +2699,22 @@
|\
|
C|HTTP_VARIANT_ALSO_VARIES\
+ |#define $* <EM>value</EM>\
+ |\
+ |\
+ |
+#; Multithread stuff
+C|MULTI_OK\
+ |#define $* <EM>value</EM>\
+ |\
+ |\
+ |
+C|MULTI_TIMEOUT\
+ |#define $* <EM>value</EM>\
+ |\
+ |\
+ |
+C|MULTI_ERR\
|#define $* <EM>value</EM>\
|\
|\
1.3 +22 -6 apache-devsite/apidoc/mkapidict
Index: mkapidict
===================================================================
RCS file: /export/home/cvs/apache-devsite/apidoc/mkapidict,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- mkapidict 1998/05/03 20:20:13 1.2
+++ mkapidict 1998/05/25 19:51:57 1.3
@@ -21,6 +21,10 @@
$InFile = $ARGV[0];
$OutFile = "$ARGV[0].bak";
+die "Need layout type" if !$ARGV[1];
+
+$Layout=$ARGV[1];
+
%Routine = ();
%Constant = ();
%Structure = ();
@@ -181,7 +185,7 @@
foreach $key (@keys) {
my ($edited, $iname, $idef, $isamp, $iref, $idesc) =
split(m:\|:, $list{$key});
- print <<EOHT;
+ print <<EOHT if $Layout == 0;
<H3>
<A NAME="$iname">
$iname
@@ -192,7 +196,8 @@
if (! $edited) {
$edited = "No prototype or definition available.";
};
- print <<EOHT;
+ if($Layout == 0) {
+ print <<EOHT;
<P>
Definition:
</P>
@@ -204,13 +209,22 @@
</DD>
</DL>
EOHT
+ } else {
+ if($edited =~ /$iname/) {
+ $edited =~ s/$iname/<B>$iname<\/B>/;
+ } else {
+ $edited="<B>$iname:</B> $edited";
+ }
+ print "<A NAME=$iname><PRE>$edited</PRE></A>\n";
+ }
$edited = &edit_inline($isamp, $iname);
- if (! $edited) {
+ if (! $edited && $Layout != 1) {
$edited = "No examples available.";
};
- print <<EOHT;
+ if($Layout != 1 || $edited) {
+ print <<EOHT;
<P>
- Usage example:
+ Usage example:
</P>
<DL>
<DD>
@@ -220,8 +234,10 @@
</DD>
</DL>
EOHT
+ }
+
if (! $idesc) {
- print <<EOHT;
+ print <<EOHT if $Layout != 1;
<P>
No documentation available.
</P>
1.1 apache-devsite/apidoc/dict-ap_acquire_mutex.html
Index: dict-ap_acquire_mutex.html
===================================================================
<P>
Acquires a mutex. Only actually does anything on multithreaded platforms.
</P>
<P>
Returns MULTI_OK, MULTI_ERR or MULTI_TIMEOUT.
</P>
