Return-Path: Delivered-To: new-httpd-archive@hyperreal.org Received: (qmail 24577 invoked by uid 6000); 5 May 1998 05:39:54 -0000 Received: (qmail 24514 invoked from network); 5 May 1998 05:39:52 -0000 Received: from localhost.hyperreal.org (HELO brianb.organic.com) (127.0.0.1) by localhost.hyperreal.org with SMTP; 5 May 1998 05:39:52 -0000 Message-Id: <3.0.3.32.19980504224702.007ca140@localhost> X-Sender: brian@localhost X-Mailer: QUALCOMM Windows Eudora Pro Version 3.0.3 (32) Date: Mon, 04 May 1998 22:47:02 -0700 To: new-httpd@apache.org From: Brian Behlendorf Subject: FWD: Self documentation for Apache C modules Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Sender: new-httpd-owner@apache.org Precedence: bulk Reply-To: new-httpd@apache.org Since there's talk about documenting the API now, and using semi-automated means of doing this, I thought I would forward a message from just over a month ago from Doug on a Perl module he's built to facilitate doc generation from code. I think at the very least someone needs to go through and make sure our hand-written docs are in sync with the docs his code generates, lest we forgot anything... but secondly, the API-docs people might want to think about this approach a bit. There's lots of verbage that can't be automated, sure. But something like this, or the Linux source-code browser, would probably accomplish much of what's being attempted. Brian >Date: Thu, 19 Mar 1998 20:00:08 +1200 >From: Doug MacEachern >Organization: SITEL Telebusiness NZ, Ltd. >X-Mailer: Mozilla 4.04 [en] (X11; I; Linux 2.0.30 i486) >To: modperl list >CC: new-httpd@apache.org >Subject: Self documentation for Apache C modules >Sender: new-httpd-owner@apache.org >Reply-To: new-httpd@apache.org > >I said a week or so ago, I'd include an apache-module-docs style >document for mod_perl directives. Instead of typing heaps of bloody >HTML, I put together Apache::ModuleDoc that works with any C module, to >generate the apache style docs. It does so on the fly via command_rec >lookups to give you a list of directives, Description, Syntax, Context, >Override, etc., including PerlSyntax for . It's not perfect, but >if you get mod_perl-1.09 and Apache-Module-0.02 (just uploaded to CPAN), >configure like so: > > > SetHandler perl-script > PerlHandler Apache::ModuleDoc > > >/manual/mod is where the real apache docs live, this handler sits on top >of that to pickup images, etc. If you open /manual/mod/index, it will >give you a listing of the compiled in modules and links to their >Apache::ModuleDoc generated documentation. >It actually fills in some bits I think are missing from the current >apache docs :-) > >-Doug > > > --=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-- specialization is for insects brian@organic.com