X-Original-To: pgsql-hackers-postgresql.org@localhost.postgresql.org Received: from localhost (av.hub.org [200.46.204.144]) by postgresql.org (Postfix) with ESMTP id C96689DC81B for ; Mon, 16 Jan 2006 07:51:16 -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 25752-07 for ; Mon, 16 Jan 2006 07:51:18 -0400 (AST) X-Greylist: from auto-whitelisted by SQLgrey- Received: from ciao.gmane.org (main.gmane.org [80.91.229.2]) by postgresql.org (Postfix) with ESMTP id 059B29DC801 for ; Mon, 16 Jan 2006 07:51:13 -0400 (AST) Received: from root by ciao.gmane.org with local (Exim 4.43) id 1EySt7-00088d-Ia for pgsql-hackers@postgresql.org; Mon, 16 Jan 2006 12:51:05 +0100 Received: from 1-1-2-48a.rny.sth.bostream.se ([82.182.133.12]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Mon, 16 Jan 2006 12:51:05 +0100 Received: from thomas by 1-1-2-48a.rny.sth.bostream.se with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Mon, 16 Jan 2006 12:51:05 +0100 X-Injected-Via-Gmane: http://gmane.org/ To: pgsql-hackers@postgresql.org From: Thomas Hallgren Subject: Re: source documentation tool doxygen Date: Mon, 16 Jan 2006 12:38:16 +0100 Lines: 33 Message-ID: <43CB85A8.9080001@tada.se> References: <20060116084936.GA7072@mcknight.de> Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-15; format=flowed Content-Transfer-Encoding: 7bit X-Complaints-To: usenet@sea.gmane.org Cc: jgardner@jonathangardner.net X-Gmane-NNTP-Posting-Host: 1-1-2-48a.rny.sth.bostream.se User-Agent: Thunderbird 1.5 (Windows/20051201) In-Reply-To: <20060116084936.GA7072@mcknight.de> X-Virus-Scanned: by amavisd-new at hub.org X-Spam-Status: No, score=0.262 required=5 tests=[AWL=0.262] X-Spam-Score: 0.262 X-Spam-Level: X-Archive-Number: 200601/454 X-Sequence-Number: 78558 I wish I've had this when I started working with PostgreSQL. This looks really good. Very useful indeed, even without the comments. What kind of changes are needed in order to get the comments in? Regards, Thomas Hallgren 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 >