Re: Jianpu Notation

[Carl Sorensen]

On 4/23/15 7:55 AM, "H. S. Teoh" <address@hidden> wrote:

>On Thu, Apr 23, 2015 at 12:34:32PM +0000, Carl Sorensen wrote:
>> 
>> 
>> On 4/22/15 10:57 PM, "Super-User" <address@hidden> wrote:
>> 
>> >Seheme, as a dialect of Lisp, can be annotated with ;; so that our
>> >Scheme codes implementing Jianpu can be documented as well.
>> 
>>But the Internals Reference (IR) is automatically generated from the
>> C++ source code of the engravers.  And we don't have any automatic
>> tools to generate IR references from Scheme engravers.
>[...]
>
>It should be possible, right? At the very least, we could use a fixed
>format, say for the comment header in the .scm file of the engraver, and
>use a script to extract and format that into documentation.

Yes, it's certainly possible.  And it can be done automatically (not from
comments) because the information is in Scheme structures with known
syntax.

But nobody has written the code to do it.

If you'd like to try that as a project, I'm certain you'd get people
(myself and others) who would provide support/review patches.

Thanks,

Cral