Hi Gurkan I'll assign those to you. I also saw a PR come in with some documentation. I'll review and merge shortly.
Thanks Jon On Tue, Jan 8, 2019 at 3:14 PM Gurkan Erdogdu <[email protected]> wrote: > Hello team > I have just opened an issue, > https://issues.apache.org/jira/browse/TOMEE-2450 to track all Java source > code comments. This will be the parent issue to track all sub-tasks. If you > want to work on Java Source file to update with comments, please open a > sub-task under this issue. I have already opened for me, > https://issues.apache.org/jira/browse/TOMEE-2451 > I am not able to assign this to me, because I have no authorization. > Regards > Gurkan > > On Mon, Jan 7, 2019 at 6:04 AM David Blevins <[email protected]> > wrote: > > > > On Jan 6, 2019, at 1:23 PM, Gurkan Erdogdu <[email protected]> > wrote: > > > > > > Thank you David. > > > One question, do we need to comment on the interface or concrete class? > > For > > > example, Assembler interface in org.apache.openejb.spi package? I think > > > commenting on the interface is better and then for extra comments in > > > concrete class. > > > > I think that's a good approach; interface where possible, concrete class > > where there are implementation specific details. The goals are > definitely > > interface worthy. All the information about AnnotationDeployer and > > AppModule is specific to the concrete class, also known as the > > ClassicAssembler. > > > > Here's some old docs on it. > > > > - http://tomee.apache.org/dev/design-assembler.html > > > > Likely we should move that info into the classes themselves, then delete > > those pages so we don't have repetitive (and therefore hard to maintain) > > sources of truth. > > > > > > -David > > > > > > >
