cvs commit: httpd-docs-1.3/apidoc APIdict.pm

[coar]

coar        01/06/22 06:02:37

  Modified:    apidoc   APIdict.pm
  Log:
  Re-order some of the routines, plus minor enhancements
  
  Revision  Changes    Path
  1.4       +47 -24    httpd-docs-1.3/apidoc/APIdict.pm
  
  Index: APIdict.pm
  ===================================================================
  RCS file: /home/cvs/httpd-docs-1.3/apidoc/APIdict.pm,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -u -r1.3 -r1.4
  --- APIdict.pm        2001/05/16 11:23:23     1.3
  +++ APIdict.pm        2001/06/22 13:02:36     1.4
  @@ -5,6 +5,9 @@
   #
   # Edit history:
   #
  +#  2001-06-19 Ken Coar
  +#    Added some documentation, and added xref-counts to the stats result.
  +#
   #  2001-05-04 Ken Coar
   #    Add 'hyperlink' Boolean setting.
   #
  @@ -79,6 +82,9 @@
       return $wip;
   }
   
  +#
  +# Return the one-character category (type) of the specified entity.
  +#
   sub category {
       my($self, $item) = @_;
       my($rtype);
  @@ -90,12 +96,19 @@
       return uc($rtype);
   }
   
  +#
  +# Return the human-readable name of a category (such as 'Routine' or
  +# 'Constant').
  +#
   sub category_name {
       my($self, $prefix) = @_;
   
       return $Prefix{uc($prefix)};
   }
   
  +#
  +# Return an unsorted array of the names of defined 'cell' entities.
  +#
   sub cell_list {
       my($self, $item) = @_;
   
  @@ -112,6 +125,9 @@
       return &writefile($self, $DictFile);
   }
   
  +#
  +# Return an unsorted array of the names of defined constant entities.
  +#
   sub constant_list {
       my($self, $item) = @_;
   
  @@ -195,6 +211,10 @@
       return join("", @Dictionary);
   }
   
  +#
  +# Return an unsorted array of the names of all defined entities,
  +# irrespective of their categories/types.
  +#
   sub entity_list {
       my($self, $item) = @_;
   
  @@ -207,6 +227,12 @@
       return $Example{$item};
   }
   
  +sub see_also {
  +    my($self, $item) = @_;
  +
  +    return $SeeAlso{$item};
  +}
  +
   #
   # Expand any xref references in a see-also list.
   #
  @@ -289,6 +315,24 @@
       return keys(%Macro);
   }
   
  +sub routine_list {
  +    my($self, $item) = @_;
  +
  +    return keys(%Routine);
  +}
  +
  +sub xref_list {
  +    my($self, $item) = @_;
  +
  +    return keys(%Xref);
  +}
  +
  +sub structure_list {
  +    my($self, $item) = @_;
  +
  +    return keys(%Structure);
  +}
  +
   #
   # Create a unique item name.  This seems weird for a dictionary, but it
   # allows the module to be used to record the same information about other
  @@ -312,24 +356,6 @@
       return $item;
   }
       
  -sub routine_list {
  -    my($self, $item) = @_;
  -
  -    return keys(%Routine);
  -}
  -
  -sub see_also {
  -    my($self, $item) = @_;
  -
  -    return $SeeAlso{$item};
  -}
  -
  -sub structure_list {
  -    my($self, $item) = @_;
  -
  -    return keys(%Structure);
  -}
  -
   #
   # Read a dictionary file and load the arrays.
   #
  @@ -444,6 +470,7 @@
   #   "macros"
   #   "structures"
   #   "constants"
  +#   "reference_lists"
   #
   sub statistics {
       my(@counter, %stats) = ();
  @@ -460,6 +487,8 @@
       $stats{"cells"} = $#counter + 1;
       @counter = keys(%Structure);
       $stats{"structures"} = $#counter + 1;
  +    @counter = keys(%Xref);
  +    $stats{"reference_lists"} = $#counter + 1;
       $stats{"lines"} = $#Dictionary + 1;
       return %stats;
   }
  @@ -501,12 +530,6 @@
       $dirty = 0;
       @uncommitted = ();
       return 0;
  -}
  -
  -sub xref_list {
  -    my($self, $item) = @_;
  -
  -    return keys(%Xref);
   }
   
   #
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]