Ticket #999 (closed task: fixed)

Opened 7 years ago

Last modified 5 years ago

Improve ImgLib documentation

Reported by: curtis Owned by: curtis
Priority: critical Milestone: imagej-2.0.0
Component: Community Version:
Severity: critical Keywords:
Cc: Blocked By: #990
Blocking: #1015

Description

As part of our code documentation, we need to flesh out the documentation of ImgLib2:

  • Flesh out the javadoc, especially for key classes
  • Serve the ImgLib2 and ImgLib1 javadoc links separately, to avoid confusion
  • Organize and unify ImgLib documentation pages on fiji.sc and developer.imagej.net.

Change History

comment:1 Changed 7 years ago by curtis

  • Blocking 1015 added

comment:2 Changed 7 years ago by curtis

  • Blocked By 990 added

comment:3 Changed 7 years ago by bdezonia

Imglib OPS also needs a thorough going over

comment:4 Changed 5 years ago by curtis

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

Flesh out the javadoc, especially for key classes

While we certainly do need to fill in missing javadoc in ImgLib2, it is A) not the highest priority given all our other tasks; and B) not something we are likely to forget to do... eventually. So I'm not going to file a replacement issue for it at this time.

Serve the ImgLib2 and ImgLib1 javadoc links separately, to avoid confusion

ImgLib1 has been removed from the codebase, so that is solved.

Organize and unify ImgLib documentation pages on fiji.sc and developer.imagej.net.

That will be covered as part of the  grand website unification.

Note: See TracTickets for help on using tickets.