From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: "Peter S. Christopher" Newsgroups: gmane.lisp.guile.devel Subject: Re: doc snarfing Date: Fri, 31 Oct 2003 13:09:27 -0600 (CST) Sender: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Message-ID: References: <3FA2969B.85C516A8@veritas.com> NNTP-Posting-Host: deer.gmane.org Mime-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII X-Trace: sea.gmane.org 1067628868 13633 80.91.224.253 (31 Oct 2003 19:34:28 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Fri, 31 Oct 2003 19:34:28 +0000 (UTC) Original-X-From: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Fri Oct 31 20:34:26 2003 Return-path: Original-Received: from monty-python.gnu.org ([199.232.76.173]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1AFf2P-0003Oc-00 for ; Fri, 31 Oct 2003 20:34:25 +0100 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.24) id 1AFf1Z-0007QU-0n for guile-devel@m.gmane.org; Fri, 31 Oct 2003 14:33:33 -0500 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.24) id 1AFf0l-00078Z-5c for guile-devel@gnu.org; Fri, 31 Oct 2003 14:32:43 -0500 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.24) id 1AFf0E-0006w4-KM for guile-devel@gnu.org; Fri, 31 Oct 2003 14:32:41 -0500 Original-Received: from [199.232.41.8] (helo=mx20.gnu.org) by monty-python.gnu.org with esmtp (TLSv1:DES-CBC3-SHA:168) (Exim 4.24) id 1AFf0E-0006vz-DM for guile-devel@gnu.org; Fri, 31 Oct 2003 14:32:10 -0500 Original-Received: from [128.135.12.12] (helo=midway.uchicago.edu) by mx20.gnu.org with esmtp (Exim 4.24) id 1AFeeK-0003Q4-1t for guile-devel@gnu.org; Fri, 31 Oct 2003 14:09:32 -0500 Original-Received: from harper.uchicago.edu (harper.uchicago.edu [128.135.12.7]) by midway.uchicago.edu (8.12.10/8.12.9) with ESMTP id h9VJ9Rse004844; Fri, 31 Oct 2003 13:09:27 -0600 (CST) Original-Received: from localhost (peterc@localhost) by harper.uchicago.edu (8.12.10/8.12.10) with ESMTP id h9VJ9RFa011875; Fri, 31 Oct 2003 13:09:27 -0600 (CST) X-Authentication-Warning: harper.uchicago.edu: peterc owned process doing -bs X-Sender: peterc@harper.uchicago.edu Original-To: Bruce Korb , guile-devel@gnu.org In-Reply-To: <3FA2969B.85C516A8@veritas.com> X-BeenThere: guile-devel@gnu.org X-Mailman-Version: 2.1.2 Precedence: list List-Id: Developers list for Guile, the GNU extensibility library List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Xref: main.gmane.org gmane.lisp.guile.devel:2942 X-Report-Spam: http://spam.gmane.org/gmane.lisp.guile.devel:2942 Hi Bruce, Thanks for the feedback. I have two questions for you: a) I couldn't find any google hits for JavaDoc and C/C++; does JavaDoc work with C-syntax? b) Given that snarfing is ugly-ish, how does the libguile team strip the documentation out of the source code? Particularly, how does one fetch the SCM_SNARF_DOCS data from source file? Thanks again, Pete On Fri, 31 Oct 2003, Bruce Korb wrote: > "Peter S. Christopher" wrote: > > > > Hi listers, > > > > I'm wondering if somebody could please give me some suggestions on > > how to snarf out the documentation for some of my own code. I'd really > > like to include documentation with the code and strip it out of the code > > using the same method that is used for the libguile code. Thanks for the > > help. > > Don't. It is really kludgy. Use Java doc, there are a lot of tools > that support it. Snarfing is ugly and used because it is also used > to extract code. If that is what you want (both code and doc extraction), > then try my tool. You can pull the strings, massage them and insert > them whereever and however you want to string them together: > > http://autogen.sourceforge.net/doc/autogen_8.html#SEC269 > > Good luck. > _______________________________________________ Guile-devel mailing list Guile-devel@gnu.org http://mail.gnu.org/mailman/listinfo/guile-devel