Documentation from comments

Hi all!

     Is there any kind of comments-processor to generate documentation?? (like javadoc) or any kind of tool to automatize documentation generation from the code?

Santiago,.

I made WebDoc once, it's a bit unstable and only works from within the same image...
Basically it's a seaside app that let's you look at the system much like javadoc.

- All comments are parsed as Markdown and formatted for the website.
- Links to methods and classes are extracted from the comments as well.
- Method references are resolved if possible and a small popup is shown when
  hovering the sources

You can download and try the image below.


http://localhost:8080/webdoc/doc/

have fun!


On 2012-10-09, at 15:53, Santiago Bragagnolo <[hidden email]> wrote:

> Hi all!
>
>     Is there any kind of comments-processor to generate documentation??
> (like javadoc) or any kind of tool to automatize documentation generation
> from the code?
>
> Santiago,.

On 2012-10-09, at 16:01, Camillo Bruni <[hidden email]> wrote:

> I made WebDoc once, it's a bit unstable and only works from within the same image...
> Basically it's a seaside app that let's you look at the system much like javadoc.
>
> - All comments are parsed as Markdown and formatted for the website.
> - Links to methods and classes are extracted from the comments as well.
> - Method references are resolved if possible and a small popup is shown when
>  hovering the sources
>
> You can download and try the image below.

of course forgot to paste the image link:
http://dl.dropbox.com/u/18184943/webdoc.zip

On 10/09/2012 04:01 PM, Camillo Bruni wrote:
> I made WebDoc once, it's a bit unstable and only works from within the same image...
> Basically it's a seaside app that let's you look at the system much like javadoc.
>
> - All comments are parsed as Markdown and formatted for the website.
> - Links to methods and classes are extracted from the comments as well.
> - Method references are resolved if possible and a small popup is shown when
>    hovering the sources

Also, Amber has a "live documentation application" that uses class
comments and more to present documentation, see it in action:

http://amber-lang.net/documentation.html

...might be worth as inspiration etc. And if you are curious about the
code you can open a Smalltalk browser (the whole Amber IDE in fact) like
this in Chrome:

        1. ctrl-shift-j to open console
        2. Type in console "smalltalk.Browser._open();" and press enter.
        3. Look in package "Documentation"


regards, Göran