These are chat archives for fiji/fiji

21st
Oct 2015
Jean-Yves Tinevez
@tinevez
Oct 21 2015 08:38
@imagejan Hey Jan check this: fiji/TrackMate@67d9b68
Thanks again!
Jean-Yves Tinevez
@tinevez
Oct 21 2015 09:09
Ourg. The javadocs errors are in HUGE numbers. It complaints about everything.
Much like my users.
warning: no @return
warning: no description for @return
warning: no @param for isIntFeature
etc.
But these warnings turn into errors in maven.
Jan Eglinger
@imagejan
Oct 21 2015 09:31
@imagejan Hey Jan check this: fiji/TrackMate@67d9b68
@tinevez looks great! thanks I'll try it.
(Oops, quoting went wrong..)
Johannes Schindelin
@dscho
Oct 21 2015 09:41
@imagejan you can edit messages in Gitter and insert an empty line with Shift+Return ;-)
Jean-Yves Tinevez
@tinevez
Oct 21 2015 12:19
Fixing javadocs makes big babies: fiji/TrackMate@b83c0b3
tpietzsch
@tpietzsch
Oct 21 2015 13:21
@tinevez If I remember correctly, the warnings are fine with maven. You probably still have a few real "error:"s in there.
Jean-Yves Tinevez
@tinevez
Oct 21 2015 13:34
@tpietzsch yes you are right. I fixed all the javadocs errors, and now I can use maven regularly with jdk8
Jean-Yves Tinevez
@tinevez
Oct 21 2015 13:50
@tpietzsch I just caught up with the consolidate branch in TrackMate3. I could run it as is with the data on my side.
Congratulations: i have the feeling the rendering is faster, and the white flashes disappeared. Did you do anything for this?
Curtis Rueden
@ctrueden
Oct 21 2015 14:39
I think @tinevez is correct that building a Fiji component from the CLI fails the build if there are any javadoc issues. We could turn off automatic javadoc generation in the main build lifecycle—this is currently only enabled for Fiji plugins, not core components of ImageJ ImgLib2 SCIFIO SciJava.
There is a separate Fiji-javadoc job responsible for generating the combined javadoc of all Fiji components. And it builds with Java 7 currently to avoid this problem.
If we disable javadoc generation for Fiji projects, then the sloppy javadocs will persist. But I don't have strong feelings, if it is too annoying. @tinevez has now overcome the annoyance, at least for TrackMate, such that maintaining good javadocs for that project will be easier now.
Jean-Yves Tinevez
@tinevez
Oct 21 2015 14:41
This will lead the way to 'javadocshathons'
More seriously we might have to correct all javadocs at one point. Let's see us in 3 years; we might want to have everything CLI running with the same jdk
Curtis Rueden
@ctrueden
Oct 21 2015 14:48
Yeah, the plan is to go to Java 8 soon... when that happens we'll have to decide how to proceed: either A) disable doclint; B) disable javadoc generation in the main build lifecycle; or C) fix all javadoc errors.
Jean-Yves Tinevez
@tinevez
Oct 21 2015 14:49
@ctrueden Any estimates on how much javadocs there would be to fix? TrackMate had some, but that was manageable.
598104 lines of Java code across all Fiji components; TrackMate is the largest component at 50672 lines of code... so naively, we are 8.5% done. :wink:
With Fiji. That doesn't count upstream orgs.
Jean-Yves Tinevez
@tinevez
Oct 21 2015 14:53
Ouch.
Curtis Rueden
@ctrueden
Oct 21 2015 14:53
Some things in that list shouldn't really be there, too, like javac.
Jean-Yves Tinevez
@tinevez
Oct 21 2015 14:54
Manually doing these 8.5% (with the sed lines provided by @tpietzsch ) took me 1.5 hours.
Curtis Rueden
@ctrueden
Oct 21 2015 14:54
That's not so bad.
Jean-Yves Tinevez
@tinevez
Oct 21 2015 14:54
Yep.
Curtis Rueden
@ctrueden
Oct 21 2015 14:54
The thing that worries me most is that Eclipse doesn't warn about all the errors that doclint finds.
So the javadoc will continually "rot" until/unless Jenkins complains loudly.
Jean-Yves Tinevez
@tinevez
Oct 21 2015 14:55
Yes; that would help.
Curtis Rueden
@ctrueden
Oct 21 2015 14:55
Eclipse does warn about a lot of them. But not all.
Actually... maybe it does, and I just didn't turn them all on in my prefs! So maybe it's not so bad.
Jean-Yves Tinevez
@tinevez
Oct 21 2015 14:55
Josh Moore once asked me to install an Eclipse plugin called 'findbugs' before I could create a PR for BioFormats.
Could this help.
?
Curtis Rueden
@ctrueden
Oct 21 2015 14:56
For javadoc, not so much, I don't think? I guess maybe findbugs has javadoc checks. But its main purpose is to find logic errors in the code.
That's a good point—we should run findbugs on everything sometimes. That would be a great student project actually.
BTW without javac in the mix, we are more than 11% done already.
Gotta go to a meeting; BBIAB.
Jean-Yves Tinevez
@tinevez
Oct 21 2015 15:00
Standard Eclipse javadoc warnings don't help much. It does not echo for instance the problems with < and >
tpietzsch
@tpietzsch
Oct 21 2015 15:03
@tinevez, I cannot imagine that I changed something that got rid of the white flashes. I didn't start to break things seriously yet :-)
Jean-Yves Tinevez
@tinevez
Oct 21 2015 15:10
ooooook.
I guess it is jdk update, then.
tpietzsch
@tpietzsch
Oct 21 2015 18:16
@tinevez or by-product of recent BDV updates. But that seems unlikely, too.
probably JDK, yes
Mark Hiner
@hinerm
Oct 21 2015 19:25
@ctrueden thanks! uploaded and on http://imagej.net/Presentations#Workshops