Copy ome.api.* documentation to omero.api.* (2)#4569
Conversation
| ["ami", "amd"] interface IMetadata extends ServiceInterface | ||
| { | ||
| /** | ||
| * Loads the <code>logical channels</code> and the acquisition |
There was a problem hiding this comment.
If "logical channels" is code should it be CamelCase? or at least not have a space in it?
|
Note that I had to make some changes in the "ice" files for ice 3.6 in order to work with the release version of ice. |
| * @param sizeX The new size across the X-axis. | ||
| * <code>null</code> if the copy should maintain | ||
| * the same size. | ||
| * @param sizeY The new size across the Y-axis. * <code>null</code> if the copy should maintain |
There was a problem hiding this comment.
Quite a lot of extraneous whitespace here that I can't see affects the rendering. Though having see that this should be split over two lines.
|
Looks fine other that minor comments above. Is there a style guide for Javadoc? I was just wondering about the use of the code tags in some of these files, there were cases where I might have used them had I been writing from scratch. Maybe at some point harmonising usage across the docs would make some sense - though that point is probably approaching infinity! |
|
@ximenesuk: I do not think we have an authoritative Javadoc style apart. I would personally be inclined to limit the usage of @jburel: from #4452, the only changes I see brought to |
|
@sbesson: no plan to add more changes |
| idempotent LongIObjectListMap loadTagContent(omero::sys::LongList ids, omero::sys::Parameters options) throws ServerError; | ||
|
|
||
| /** | ||
| * Loads all the tag Sets. Returns a collection of |
There was a problem hiding this comment.
Sorry, this probably needs to be TagSet or TagSets too cf method above.
|
@sbesson agree on style comment. Changes look fine, just the one tiny inconsistency noted. |
|
Pushed |
|
Given the limited scope of the change do you want to merge this now or wait until a after a build? |
|
Deferring to @jburel with regard to the merging decision. |
|
Merging, we can improve the doc in a follow-up PR I noticed several things when I made some adjustments to work with ice 3.6 |
3 participants
See https://trello.com/c/KLCaZX4X/19-copy-ome-api-documentation-to-omero-api
Follow-up of #4547, this PR copies more of the ome.api.* Javadoc documentation into the slice classes.
To review this PR, either build the slice documentation via
release-slice2htmlor use the published CI documentation orOMERO.docs*artifacts. Check the links are all working and the method parameters match.