On 2010-01-26 10.55, Stanislav Muhametsin wrote:
Somewhere in tutorial it was said that one entity can have many entity
types, and that it is further explained "elsewhere". That elsewhere
could be the complete manual.
This needs to be clarified I think. We removed the support for having
many concurrent entity types. What is still there is the ability to load
an entity with a given type using a subtype.
Also, I've seen interface "Usecase" sometimes when I browse for methods
using auto-complete. However, I couldn't find anything concrete or
actually explaining, what it is and what it is for. Nor did I have time
to dig around. :) Some kind of example would be nice, along with
detailed documentation.
Yes, I'm putting this into a page on UnitOfWork. UoW are instances of
Usecase, basically.
Also, at least when using Qi4j from Eclipse, apparently folder
qi4j-core\runtime\src\main\resources has to be added to classpath (or
one has to create the appropriate
META-INF\services\org.qi4j.bootstrap.Qi4jRuntime file with appropriate
contents to own class path), otherwise Qi4j will fail to start app. Not
sure if there is any other solution for that, but if that is only one,
it would be nice to document.
Good point.
Also the usage of "metaInfo" is nice to be documented as one way of
passing data from outside into the Qi4j app.
Would it be enough to put this into the Javadoc?
The fact that "Initializable" gets executed also when instantiating
prototype is also good to be documented. I don't remember right now if
Lifecycle's "created" method gets executed when calling "instance" or
"instanceFor", but that is also nice to specify.
Same here, is it enough to put this in the Javadoc?
There's a tradeoff here in terms of documentation, because if we keep it
in the Javadoc it is easier to keep updated, and ensure that different
versions have the correct documentation.
What do people prefer? To have more extensive Javadocs, or to put this
on the website? If on website, how do we handle different versions, etc.?
The recent change of using Preferences EntityStore should be documented
too (why, how, theory, examples). I hadn't updated my Qi4j repo for a
loong time, and when I did, I had to dig that information out somewhere
from mailing list.
Yes, how entities-configuration-preferences work together needs, to be
documented, agreed!
The org.qi4j.api.selection package is quite undocumented - if it is
relevant at all, would be nice to know what that thing is about.
To start with maybe a package documentation for the JavaDoc would be a
good beginning.
The proper documentation of @Invocation, @Uses, @State injections -
again, why, how, theory, examples. Especially examples. :)
Again, would putting this into Javadocs be enough?
The @Structure injection allows Qi4jSPI type, which in case allows
inspection of composite's state to everyone (at least by default
implementation of Qi4jSPI) by using method getState(...) . That would be
nice to document too.
Well, that's all that quickly springs on my mind right now. I'll try to
put down more stuff if I think of it. :)
Excellent!
I've put a number of these into Jira. I had hoped to work on the website
today, but realize that the current version of SiteVision is unusable.
I'll try to get it updated ASAP so I can make these changes.
/Rickard
_______________________________________________
qi4j-dev mailing list
[email protected]
http://lists.ops4j.org/mailman/listinfo/qi4j-dev
