Clear, concise documentation for a small application

[Geo]

I have just finished an application and wish to document it.
I am not familiar with formats, styles of application docs for java.

I wish to list the functions of the application, then, follow the sequence
of classes/methods within the functions.

This listing of classes and methods in order of execution is very lenghty
and tedious; a pain for the programmers to follow. Flow diagrams come to
mind, but I'm not sure of the level of detail necessary.

I am looking for a format that is high-level enough to be concise, but detailed
enough to be useful for later modifications.

Any suggestions, format examples?

Thank you,

Geo

[Ako]

Its all been taken care of by java folks, you can use javadoc to create documentation
exactly the way java documentation is done. look at sun's website for a simple
and straight forward tutorial, or any good book.

Ako


"Geo" <gkozel@allstate.com> wrote:
>
>I have just finished an application and wish to document it.
>I am not familiar with formats, styles of application docs for java.
>
>I wish to list the functions of the application, then, follow the sequence
>of classes/methods within the functions.
>
>This listing of classes and methods in order of execution is very lenghty
>and tedious; a pain for the programmers to follow. Flow diagrams come to
>mind, but I'm not sure of the level of detail necessary.
>
>I am looking for a format that is high-level enough to be concise, but detailed
>enough to be useful for later modifications.
>
>Any suggestions, format examples?
>
>Thank you,
>
>Geo
>
>

[Leonardo Kasperavicius]

Or you can use too the Poseidon for UML, it's free and Java compatible.
http://www.gentleware.com/products/download.php3

Leonardo Kasperavicius


"Ako" <ays73@hotmail.com> escreveu na mensagem
news:3b8bd8a2$1@news.devx.com...
>
> Its all been taken care of by java folks, you can use javadoc to create
documentation
> exactly the way java documentation is done. look at sun's website for a
simple
> and straight forward tutorial, or any good book.
>
> Ako
>
>
> "Geo" <gkozel@allstate.com> wrote:
> >
> >I have just finished an application and wish to document it.
> >I am not familiar with formats, styles of application docs for java.
> >
> >I wish to list the functions of the application, then, follow the
sequence
> >of classes/methods within the functions.
> >
> >This listing of classes and methods in order of execution is very lenghty
> >and tedious; a pain for the programmers to follow. Flow diagrams come to
> >mind, but I'm not sure of the level of detail necessary.
> >
> >I am looking for a format that is high-level enough to be concise, but
detailed
> >enough to be useful for later modifications.
> >
> >Any suggestions, format examples?
> >
> >Thank you,
> >
> >Geo
> >
> >
>