unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
From: "Peter S. Christopher" <peterc@midway.uchicago.edu>
Subject: Re: doc snarfing
Date: Fri, 31 Oct 2003 13:09:27 -0600 (CST)	[thread overview]
Message-ID: <Pine.GSO.4.21.0310311303030.3967-100000@harper.uchicago.edu> (raw)
In-Reply-To: <3FA2969B.85C516A8@veritas.com>

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


       reply	other threads:[~2003-10-31 19:09 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <3FA2969B.85C516A8@veritas.com>
2003-10-31 19:09 ` Peter S. Christopher [this message]
2003-10-31 23:53   ` doc snarfing Nic Ferrier
2003-10-31 16:43 Peter S. Christopher

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/guile/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=Pine.GSO.4.21.0310311303030.3967-100000@harper.uchicago.edu \
    --to=peterc@midway.uchicago.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).