I can wholeheartedly underline Joey's comments. The doco generated courtesy
of Maven is really nice but what is missing for the tag parameters, next to
the parameter name, type, applicability, description and mandatory
(true/false), is for sure a complete list of the possible parameter values.
I'm sure there's already information about most of the possible values in
the xdocs; it probably just needs to get included into the generated doco?

Cheers, Bernhard

P.S. Not much new info added to Joey's comment but it stresses the point
that the inclusion of possible parameter values is really essential,
especially for new users.


-----Urspr�ngliche Nachricht-----
Von: Joey Gibson [mailto:[EMAIL PROTECTED]]
Gesendet: Montag, 16. Dezember 2002 02:34
An: [EMAIL PROTECTED]
Betreff: Re: [Xdoclet-user] SURVEY: Documentation Format Questions


On Sun, 15 Dec 2002 18:13:51 -0500, "Brian Topping"
<[EMAIL PROTECTED]> wrote:

||| what to write!  Take a look at http://xdoclet.sourceforge.net/1.2beta/
and
||| make some suggestions, please!  What are your thoughts on this issue?
Help
||| us help you help yourselves! :-)

I like the general format, but for several of the attributes, it would
be nice if the doc listed the possible values. For instance, Weblogic
supports four different concurrency-strategy settings, including one
called Optimistic. XDoclet seems to only support three right now, and
Optimistic isn't one of them. If the three that it does support had been
listed, I would have known instantly that Optimistic wouldn't work. This
is just one example where it would be useful information to know. I'd be
happy to help with this effort if it is deemed useful by everyone else.

Joey

-- Blue canary in the outlet by the lightswitch,
--  who watches over you...




-------------------------------------------------------
This sf.net email is sponsored by:
With Great Power, Comes Great Responsibility 
Learn to use your power at OSDN's High Performance Computing Channel
http://hpc.devchannel.org/
_______________________________________________
Xdoclet-user mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-user

This e-mail and any attachment is for authorised use by the intended recipient(s) 
only.  It may contain proprietary material, confidential information and/or be subject 
to legal privilege.  It should not be copied, disclosed to, retained or used by, any 
other party.  If you are not an intended recipient then please promptly delete this 
e-mail and any attachment and all copies and inform the sender.  Thank you.


-------------------------------------------------------
This sf.net email is sponsored by:
With Great Power, Comes Great Responsibility
Learn to use your power at OSDN's High Performance Computing Channel
http://hpc.devchannel.org/
_______________________________________________
Xdoclet-user mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-user

Reply via email to