You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@jena.apache.org by "Bruno P. Kinoshita" <br...@yahoo.com.br> on 2014/10/04 19:09:56 UTC

Javadoc's and TODO's

Hi all, 
I'm debugging the code and learning with the test cases, in order to produce a patch to JENA-632 (thanks for answering the other thread Andy - I believe now I understand what needs to be done in the issue).
At the moment I'm debugging Fuseki to learn the work flow of a user submitted query, but noticed several classes and methods are missing Javadoc's. If there is no objection I'll try to create a single patch with a few Javadoc's that I consider that could be useful for other newcomers like me. 
Also, as a side note, there are few TODO's in the code base. Is there a report generated with Maven in the Jena website? Something like Maven taglist maybe? Like [1]. I'm using a Jenkins server that I maintain with the tasks plug-in to take a look at FIXME, TODO and TBD in the code [2] in the meanwhile.
All the bestBruno
[1] http://commons.apache.org/proper/commons-codec/taglist.html [2] http://builds.tupilabs.com/job/apache-jena/1/tasksResult/

Re: Javadoc's and TODO's

Posted by Andy Seaborne <an...@apache.org>.

On 04/10/14 18:09, Bruno P. Kinoshita wrote:
> Hi all,
>
> I'm debugging the code and learning with the test cases, in order to
> produce a patch to JENA-632 (thanks for answering the other thread
> Andy - I believe now I understand what needs to be done in the
> issue).
>
> At the moment I'm debugging Fuseki to learn the work flow of a user
> submitted query, but noticed several classes and methods are missing
> Javadoc's. If there is no objection I'll try to create a single patch
> with a few Javadoc's that I consider that could be useful for other
> newcomers like me.

That would be great!

> Also, as a side note, there are few TODO's in the code base. Is there
> a report generated with Maven in the Jena website? Something like
> Maven taglist maybe? Like [1]. I'm using a Jenkins server that I
> maintain with the tasks plug-in to take a look at FIXME, TODO and TBD
> in the code [2] in the meanwhile.

We don't have such a report generated.  A quick sampling showed that 
many are out of date (but some are downright worrying!)

e.g. I know that jena-iri has many, but I think they are for features to 
help it as a standalone library, not the usage Jena makes.

	Andy

>
> All the bestBruno [1]
> http://commons.apache.org/proper/commons-codec/taglist.html [2]
> http://builds.tupilabs.com/job/apache-jena/1/tasksResult/
>