List Info

Thread: Automatic documentation generation




Automatic documentation generation
user name
2006-07-05 01:56:16
Hi.

I'm just stating with Smalltalk and wat to do some
automatic document
generation.

What whould be the best source of information
("inspect !" output,
sourcecode, special programs/processors) to create
interlinked
documentation?

I'm able to process almost any source, so every idea is
welcome.

Greetings,
  Bram


_______________________________________________
help-smalltalk mailing list
help-smalltalkgnu.org

http://lists.gnu.org/mailman/listinfo/help-smalltalk
Automatic documentation generation
user name
2006-07-05 06:31:44
Bram Neijt wrote:
> Hi.
>
> I'm just stating with Smalltalk and wat to do some
automatic document
> generation.
>
> What whould be the best source of information
("inspect !" output,
> sourcecode, special programs/processors) to create
interlinked
> documentation?
>
Uhm, *interlinked* is quite a mess.  The automatic
documentation 
generator in examples/Publish.st does not generate many
links (none for 
the parts derived from user source code) because there is no
standard.  
It generates indexes when it outputs Texinfo, though.

But you can get everything you want from the Class and
CompiledMethod 
objects: class comment, class category, variables, method
source code, 
and so on.  Note that some of the methods you need are in
the 
superclasses, Behavior and CompiledCode respectively.

Paolo



_______________________________________________
help-smalltalk mailing list
help-smalltalkgnu.org

http://lists.gnu.org/mailman/listinfo/help-smalltalk
[1-2]

about | contact  Other archives ( Real Estate discussion Medical topics )