httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wr...@apache.org
Subject cvs commit: httpd-2.0/docs/manual/misc index.html API.html
Date Sat, 22 Sep 2001 15:45:22 GMT
wrowe       01/09/22 08:45:22

  Modified:    docs/manual/developer index.html
               docs/manual/misc index.html
  Added:       docs/manual/developer documenting.html
  Removed:     docs/manual/developer documenting
               docs/manual/misc API.html
  Log:
    Move API.html over to manual/developer, begin some cleanup.
  
    Could a DoxyGen'er please update the guidlines in documenting.html?
  
  Revision  Changes    Path
  1.10      +16 -4     httpd-2.0/docs/manual/developer/index.html
  
  Index: index.html
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/developer/index.html,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- index.html	2000/11/29 22:51:01	1.9
  +++ index.html	2001/09/22 15:45:22	1.10
  @@ -16,10 +16,22 @@
   
   <h1 align="center">Developer Documentation for Apache-2.0</h1>
   
  -<p><a href="hooks.html">Apache Hook Functions</a></p>
  -<p><a href="modules.html">Converting Apache 1.3 Modules to Apache 2.0</a></p>
  -<p><a href="debugging.html">Debugging Memory Allocation in APR</a></p>
  -<p><a href="../misc/API.html">Apache 1.3 API Notes</a></p>
  +<p>Many of the documents on these Developer pages are lifted from Apache 1.3's
  +   documentation.  While they are all being updated to Apache 2.0, they are
  +   in different stages of progress.  Please be patient, and point out any
  +   discrepancies or errors on the developer/ pages directly to the 
  +   dev@httpd.apache.org mailing list.</p>
  +
  +<h3>Topics</h3>
  +<dl>
  +   <dt><a href="API.html">Apache 2.0 API Notes</a></dt>
  +      <dd>Overview of Apache's Application Programming Interface.</dd>
  +   <dt><a href="hooks.html">Apache Hook Functions</a></dt>
  +   <dt><a href="modules.html">Porting Apache 1.3 Modules</a></dt>
  +   <dt><a href="debugging.html">Debugging Memory Allocation</a></dt>
  +   <dt><a href="documenting.html">Documenting Apache 2.0</a></dt>
  +</dl>
  +
   <!--#include virtual="footer.html" -->
   </body>
   </html>
  
  
  
  1.1                  httpd-2.0/docs/manual/developer/documenting.html
  
  Index: documenting.html
  ===================================================================
  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
  <html>
  <head>
  <title>Documenting Apache 2.0</title>
  </head>
  <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
  <BODY
   BGCOLOR="#FFFFFF"
   TEXT="#000000"
   LINK="#0000FF"
   VLINK="#000080"
   ALINK="#FF0000"
  >
  
  <!--#include virtual="header.html" -->
  
  <h1 align="center">Documentating Apache 2.0</h1>
  
  <p>Apache 2.0 uses DoxyGen to document the API's and global variables in the
     the code.  This will explain the basics of how to document using DoxyGen.
  
  <p>To start a documentation block, use /**<br />
     To end a documentation block, use */</p>
  
  <p>In the middle of the block, there are multiple tags we can use:</p>
  <pre>
      Description of this functions purpose
      @param parameter_name description
  </p>
  
  <p>The deffunc is not always necessary.  DoxyGen does not have a full parser 
     in it, so any prototype that use a macro in the return type declaration 
     is too complex for scandoc.  Those functions require a deffunc.</p>
  
  <p>An example (using &&gt; rather than &gt;):</p>
  <pre>
  /**
   * return the final element of the pathname
   * @param pathname The path to get the final element of
   * @return the final element of the path
   * @tip Examples:
   * &lt;pre&gt;
   *                 "/foo/bar/gum"   -&&gt; "gum"
   *                 "/foo/bar/gum/"  -&&gt; ""
   *                 "gum"            -&&gt; "gum"
   *                 "wi\\n32\\stuff" -&&gt; "stuff"
   * &lt;/pre&gt;
   * @deffunc const char * ap_filename_of_pathname(const char *pathname)
   */
  </pre>
  
  <p>At the top of the header file, always include:</p>
  <pre>
  /**
   * @package Name of library header
   */
  </pre>
  
  <p>ScanDoc uses a new html file for each package.  The html files are named
     {Name_of_library_header}.html, so try to be concise with your names.</p>
   
  <!--#include virtual="footer.html" -->
  </body>
  </html>
  
  
  
  1.17      +0 -6      httpd-2.0/docs/manual/misc/index.html
  
  Index: index.html
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/misc/index.html,v
  retrieving revision 1.16
  retrieving revision 1.17
  diff -u -r1.16 -r1.17
  --- index.html	2001/08/24 17:08:25	1.16
  +++ index.html	2001/09/22 15:45:22	1.17
  @@ -20,12 +20,6 @@
     Apache web server development project.
     </P>
     <DL>
  -   <DT><A
  -        HREF="API.html"
  -       >API</A>
  -   </DT>
  -   <DD>Description of Apache's Application Programming Interface.
  -   </DD>
      <DT><A HREF="custom_errordocs.html">How to use XSSI and Negotiation 
   	for custom ErrorDocuments</A>
      </DT>
  
  
  

Mime
View raw message