X-Original-To: pgsql-www-postgresql.org@localhost.postgresql.org
Received: from localhost (av.hub.org [200.46.204.144])
	by postgresql.org (Postfix) with ESMTP id E44539DC847;
	Mon, 16 Jan 2006 19:32:12 -0400 (AST)
Received: from postgresql.org ([200.46.204.71])
	by localhost (av.hub.org [200.46.204.144]) (amavisd-new, port 10024)
	with ESMTP id 70732-01; Mon, 16 Jan 2006 19:32:14 -0400 (AST)
X-Greylist: from auto-whitelisted by SQLgrey-
X-Greylist: from auto-whitelisted by SQLgrey-
Received: from candle.pha.pa.us (candle.pha.pa.us [70.90.9.53])
	by postgresql.org (Postfix) with ESMTP id BE5249DC87A;
	Mon, 16 Jan 2006 19:32:09 -0400 (AST)
Received: (from pgman@localhost)
	by candle.pha.pa.us (8.11.6/8.11.6) id k0GNW7D28523;
	Mon, 16 Jan 2006 18:32:07 -0500 (EST)
From: Bruce Momjian <pgman@candle.pha.pa.us>
Message-Id: <200601162332.k0GNW7D28523@candle.pha.pa.us>
Subject: Re: [HACKERS] source documentation tool doxygen
In-Reply-To: <20060116084936.GA7072@mcknight.de>
To: Joachim Wieland <joe@mcknight.de>
Date: Mon, 16 Jan 2006 18:32:07 -0500 (EST)
CC: pgsql-hackers@postgresql.org, jgardner@jonathangardner.net,
	PostgreSQL www <pgsql-www@postgresql.org>
X-Mailer: ELM [version 2.4ME+ PL121 (25)]
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset=US-ASCII
X-Virus-Scanned: by amavisd-new at hub.org
X-Spam-Status: No, score=0.119 required=5 tests=[AWL=0.119]
X-Spam-Score: 0.119
X-Spam-Level: 
X-Archive-Number: 200601/176
X-Sequence-Number: 9364


Wow, looks great.  Is that URL stable?  Can we link to it from the
PostgreSQL developers page?

	http://www.postgresql.org/developer/coding

---------------------------------------------------------------------------

Joachim Wieland wrote:
> I've created a browsable source tree "documentation", it's done with the
> doxygen tool.
> 
> http://www.mcknight.de/pgsql-doxygen/cvshead/html/
> 
> There was a discussion about this some time ago, Jonathan Gardner proposed
> it here:
> 
> http://archives.postgresql.org/pgsql-hackers/2004-03/msg00748.php
> 
> quite a few people found it useful but it somehow got stuck. The reason was
> apparently that you'd have to tweak your comments in order to profit from
> it as much as possible.
> 
> However I still think it's a nice-to-have among the online documentation
> and it gives people quite new to the code the possibility to easily check
> what is where defined and how... What do you think?
> 
> doxygen can also produce a pdf but I haven't succeeded in doing that so far,
> pdflatex keeps bailing out. Has anybody else succeeded building this yet?
> 
> 
> 
> Joachim
> 
> -- 
> Joachim Wieland                                              joe@mcknight.de
> C/ Usandizaga 12 1?B                                           ICQ: 37225940
> 20002 Donostia / San Sebastian (Spain)                     GPG key available
> 
> ---------------------------(end of broadcast)---------------------------
> TIP 3: Have you checked our extensive FAQ?
> 
>                http://www.postgresql.org/docs/faq
> 

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073