Quoting Rickard Öberg <[email protected]>:
I'll be working on these today.
As already pointed out, if you have any requests for things that
need to be in the docs, please let us know! It is vastly easier to
write docs if there's a concrete question to be answered.
Here's a bunch of ideas:
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.
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.
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.
Also the usage of "metaInfo" is nice to be documented as one way of
passing data from outside into the Qi4j app.
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.
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.
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.
The proper documentation of @Invocation, @Uses, @State injections -
again, why, how, theory, examples. Especially examples. :)
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. :)
_______________________________________________
qi4j-dev mailing list
[email protected]
http://lists.ops4j.org/mailman/listinfo/qi4j-dev
