Great idea! It will encourage us to keep our comments up to date.
Benito J. Gonzalez
Manager, Enterprise Web Application Development
Information Technology Department
University of California, Merced
Desk: 209.228.2974
Cell: 209.201.5052
Email: [email protected]
On 10/25/10 13:43, Susan Bramhall wrote:
At the Unconference, I volunteered to document the default
personDirectoryContext.xml. In the course of documenting
configuration instructions and examples for the most common Person
Directory basics, I realized that this powerful API and all the
existing implementations should to be documented. Even if I could
correctly write documentation for all the classes as currently
implemented, the wiki is bound to fall out of date as soon as any
change is made to the code base. My thinking is that the best way to
ensure that the documentation is current is to link to an html
published version of the JavaDoc. I have two questions for the list:
1. Do you agree that having JavaDoc published somewhere on the web
is a good idea? See, for example,
http://www.sonarsource.org/docs/ where you can browse to the
javadoc for any version.
2. Is this something the existing build infrastructure could do -
at least when a release is tagged?
Susan
--
Susan Bramhall ([email protected] <mailto:[email protected]>)
Enterprise Architect
Yale University Information Technology Services (ITS)
25 Science Park, 150 Munson St, New Haven, CT 06520
Phone: 203 432 6697
--
You are currently subscribed to [email protected] as:
[email protected]
To unsubscribe, change settings or access archives, see
http://www.ja-sig.org/wiki/display/JSG/uportal-dev
--
You are currently subscribed to [email protected] as:
[email protected]
To unsubscribe, change settings or access archives, see
http://www.ja-sig.org/wiki/display/JSG/uportal-dev
