Ticket #1793 (closed defect: fixed)

Opened 6 years ago

Last modified 6 years ago

Make sure that our main projects have Javadocs built by Jenkins jobs

Reported by: dscho Owned by: dscho
Priority: major Milestone: imagej2-b8-analysis
Component: Server Admin Version:
Severity: serious Keywords:
Cc: curtis Blocked By:
Blocking: #1919

Description

So far, we build Javadocs for ImageJ 1.x, ImageJ2, ImgLib2 and Fiji. But most notably, scijava-common does not have any public javadocs.

Change History

comment:1 Changed 6 years ago by dscho

scijava-common is fixed since build 118 of  http://jenkins.imagej.net/job/SciJava-common/. What other projects do we need to think of? TrakEM2, mpicbg?

comment:2 Changed 6 years ago by curtis

Ideally, we would build the Javadocs for all projects that Jenkins handles. However, in general, building Javadocs is very slow, which is why there are separate ImageJ-daily and ImgLib-daily jobs. Maybe instead of calling them "*-daily" we could call them "*-docs" instead? Or I guess we could just combine them and always generate the docs with every commit. Originally that seemed like overkill though, resulting in much longer job times for little additional benefit.

comment:3 Changed 6 years ago by dscho

Yep, I agree, in general, javadocs are very slow. For example, for the Fiji sources it takes almost half an hour...

For scijava-common, it is fast, so I did not bother with an extra job.

It appears to me to be more important to identify the projects that need javadoc'ing, maybe SCIFIO?

comment:4 Changed 6 years ago by curtis

It appears to me to be more important to identify the projects that need javadoc'ing, maybe SCIFIO?

As I said, I think all projects that our Jenkins handles should be javadoc'ed. So yes, that would include SCIFIO.

comment:5 Changed 6 years ago by dscho

Indeed, I had to split off SciJava-common-javadoc because it took too long.

comment:6 Changed 6 years ago by bdezonia

  • Blocking 1919 added; 1608 removed
  • Milestone changed from imagej2-b7-ndim-data to imagej2-b8-analysis

comment:7 Changed 6 years ago by dscho

  • Status changed from new to closed
  • Resolution set to fixed

I also added a job for SCIFIO. It is time to close this ticket now because it is too open-ended.

Note: See TracTickets for help on using tickets.