amforth-devel

[Amforth] Forth documenting system?

[Hannu V. <vu...@ms...>]

Hi!

I have written some forth code and I've forgot what it does. I got this idea of generating documentation and started to google a bit. AFAIK only amfort has autogenerated documentation.

I'm not familiar with perl and I just had quick look for makewords script. I got understanding that it is heavily amforth specific. I also found perldoxygen from sourceforge.
If I count 3 3 + . I get result as some work to migrate to perldoxygen and nice layout of doxygen pages. As this is forth, the amount of work depends of value of 3 :) And the result would be doxygen support for Forth.

Has anyone had this problem before and how have you handled it?

Best regards,
Hannu Vuolasaho
 		 	   		  

Re: [Amforth] Forth documenting system?

[Matthias T. <mt...@we...>]

Hi Hannu,

> I have written some forth code and I've forgot what it does. I got
> this idea of generating documentation and started to google a bit.
> AFAIK only amfort has autogenerated documentation.

Not at all. You may look at the linux kernel sources as well ;)
Mixing code and its documentation is is a very old idea. e.g.
TeX is written in a file format that is used to generate the
source code for the compiler and the documentation (for TeX
itself).

> I'm not familiar with perl and I just had quick look for makewords
> script. I got understanding that it is heavily amforth specific.

Absolutly. When I started amforth, doxygen and friends are not
usable for assembly sources. Furthermore I wanted a tool that
could generate forth-like hypertext'ed html from the assembler
sources. _That_ is indeed something no other tool I know of can do.

> And the result would be doxygen support for Forth.

You may want to look at gforth. They use something forth-like
to generate the docs. And you may want to read
the book from Stephen Pelc: www.mpeforth.com/arena/ProgramForth.pdf

Matthias