Menu

#1 Improve documentation of code

open
nobody
None
5
2007-02-02
2007-02-02
krebu
No

* Java doc improved
* README adapted
* architecture document made
* Poseidon used to scan UML diagram

------- Additional Comment #1 From M. Guenter 2005-02-20 01:37 -------

Also using flashcards.swx. This file will contain the manual.

FOLLOWUP:

Datum: 2005-11-12 16:29
Sender: guenter
Angemeldet: JA
user_id=106

What is intended:
* The README in the root directory should be checked, if something
must be added to it
* javadoc should crate no errors and document the code.
* If necessary an architecture documented should be created/edited
to show class diagram, package diagram and some design principles
used in JFlash. (jflash_architecture.sxw)

Poseidon is the professional tool that comes from ARGOUML and
can be used to create UML-diagrams from code.

Datum: 2005-03-20 14:43
Sender: guenter
Angemeldet: JA
user_id=106

flashcards.sxw ist up to date and can be used for reference.
I did that.

The Poseidon scan we also don't do.

I would like you to work on the architecture document (new document
jflash_architecture.sxw)

and to make sure, that javadoc doesn't produce that many errors.

Discussion