[EMAIL PROTECTED] wrote:
I don't think I have enough knowledge about merlin to document it well yet,
but eventaully, I will be glad to help document stuff, becuase I have years
of "corporate" software development experience (which means I do a LOT of
documentation and have gotten pretty good at it)

Some things to conside ...


Firstly - Merlin provides a number of different layers of involvement. You have your classic avalon components that perhaps make requests for the typical "urn:avalon:home" working directory or other such standard context entries. These are the normal components - e.g. the content that exists in avalon-components.

A second tier of components, often referred to as facilities are components that request access to the meta-model. This opens up an entirely new scope - components that can manipulate the runtime environment, change the rules, add and remove component models, etc. This extent of this capability is expressed in the javadoc apis for the composition package. This includes the composition/data package covering serializable component deployment scenarios, composition/event dealing with composition changes, and composition/model dealing with model management (context, configuration, dependency management, etc.).

If you combines the framework API with the composition API, repository API, and Avalon Logging API, you have the basis of a rather complete component management specification.


Regarding javadocs, I agree that they are helpful (and I would like to
think they should be required) but I believe that the most helpful javadocs
are those that include simple examples as well in their comments.

I agree 100%


Steve.


Anyway, thats my 2c worth

Andy



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]




--

|------------------------------------------------|
| Magic by Merlin                                |
| Production by Avalon                           |
|                                                |
| http://avalon.apache.org/merlin                |
| http://dpml.net/merlin/distributions/latest    |
|------------------------------------------------|

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Reply via email to