[#PULSE-106] Improve JAVA-DOC big time (at least for website administration)

pulse

Improve JAVA-DOC big time (at least for website administration)

Created: 2009-10-26 23:37 UTC Updated: 2010-09-02 14:16 UTC

Component/s:

component-cms, component-core, component-shop, component-statistics, component-store, component-survey, container, pulse-demo-layout

Affects Version/s:

0.8

Fix Version/s:

None

Time Tracking:

Not Specified

Description

« Hide

The JAVA-Doc of the pulse website-administration does not provide sufficient information regarding every important aspect (...mea culpa)...

This means I have to put a major effort in properly commenting classes regarding the following aspects (at least):

- request-parameters and their effect/function for controllers
- appearance of results (may they be xml/json...)
- general class and package-documentation

Try to add screen-shots where necessary/helpful

Try (to find a way) to link website-administration-manual

Definitely add better descriptions of the configurations/-properties... as well as add better/more possibilities to configure the website administration (e.g. store->image-groups...)

All

Comments

Work Log

Change History

Sort Order:

[ Permlink | « Hide ]

Daniel Dietz added a comment - 2010-09-02 14:16 UTC

This problem should mostly resolve itself, once the new viewport is available where a much higher effort is put in providing proper documentation.
The default configuration XML-files will first of all be reduced in absolute amount and will be better documented as well as have in-line comments for better understanding.
The result appearance of results - whether XML or JSON - will be clear once all the results have been JAXB-enabled -> this will automatically lead to standardised JSON-output as well...
The documentation of request-parameters will be clearer through using the request-bean-concept throughout the creation of all new components.