<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <meta content="text/html; charset=ISO-8859-1"
 http-equiv="Content-Type">
</head>
<body text="#000000" bgcolor="#ffffff">
I've hit the noweb documentations several times, and bounced each time.
<br>
<br>
robodoc looks like it might be suitable, but I was hoping? expecting?
that there would be some standard approach.&nbsp; (With robodoc each person
must define their own markup flags for lisp, as it's not a standardly
supported language.&nbsp; This is inferior to having a standard for what
indicates a function name, etc.)<br>
<br>
When I look at the examples of Scribble literate programming, they seem
to make the code obscure in the original file.&nbsp; This is not at all what
I want.&nbsp; The documentation is documentation &lt;i&gt;of the
code&lt;/i&gt;.&nbsp; It's the code that's the important thing.&nbsp; The
documentation is just to make it easy to find, and to use.&nbsp; Internal
comments are to make it easier to understand in detail.&nbsp; But it's the
code that is primary, and anything that obscures it is NOT what I
want.&nbsp; (One of the problems I have with robodoc is that it's too
verbose when you write it, but it's simple and unintrusive compared to
the examples I've seen of noweb or embedded Scribble.)<br>
<br>
I was really looking for something simple like Doxygen or Javadoc.&nbsp;
Something that steps through the code, looks at comments, and pulls out
of marked comments into a documentation file.&nbsp;&nbsp; (Well, the programs
might not be simple, but how you mark-up the code for them is.)<br>
<br>
<br>
On 04/05/2011 12:02 PM, Deren Dohoda wrote:
<blockquote
 cite="mid:BANLkTikc-jHkkRXFSXK6MxNQmMq7Vf6G-Q@mail.gmail.com"
 type="cite">
  <meta http-equiv="Context-Type"
 content="text/html; charset=ISO-8859-1">
  <p>Have you looked at literate programming tools like noweb, and the
literate tools in Racket?</p>
  <div>On Apr 5, 2011 2:52 PM, "Charles Hixson" &lt;<a
 moz-do-not-send="true" href="mailto:charleshixsn@earthlink.net">charleshixsn@earthlink.net</a>&gt;
wrote:<br>
&gt; Is there there a program roughly similar to doxygen or javadoc for
  <br>
&gt; Scheme or Racket?<br>
&gt; <br>
&gt; I know myself to well to believe that I will document something,
and <br>
&gt; keep the documentation current, unless it is right next to the
code <br>
&gt; being documented. (It didn't work in Fortran or C when that's one
of <br>
&gt; the things I was being paid to do, so it's not likely to work
now.) But <br>
&gt; javadoc and doxygen are things I find easy to just update the <br>
&gt; documentation when I change the code. If I understand correctly <br>
&gt; Scribble wants the documentation to be in a separate file, so I
need a <br>
&gt; different method.<br>
&gt; <br>
&gt; From past history I prefer documentation embedded in comments
preceding <br>
&gt; the code item that it documents. I never did take to Python <br>
&gt; documentation strings. And I'd like to be able to produce two
kinds of <br>
&gt; documentation: one that documents everything and one that only <br>
&gt; documents externally visible items. My ideal output forms are HTML
and <br>
&gt; odt (OpenOffice) files.<br>
&gt; <br>
&gt; _________________________________________________<br>
&gt; For list-related administrative tasks:<br>
&gt; <a moz-do-not-send="true"
 href="http://lists.racket-lang.org/listinfo/users">http://lists.racket-lang.org/listinfo/users</a><br>
  </div>
</blockquote>
<br>
</body>
</html>