Copy ome.api.* documentation to omero.api.* (4)#4605
Conversation
|
Conflicting PR. Removed from build OMERO-DEV-merge-push#303. See the console output for more details.
|
|
This PR conflicts with #4452 |
|
Due to a bug in string parsing in ice, check for single quote in the documentation |
|
|
||
| /** | ||
| * Returns <code>true</code> if the {@link omero.model.Job} is | ||
| * running, i.e. has an attached {@link omero.model.Process}. |
There was a problem hiding this comment.
The i.e. here has the effect of the index entry being just:
Returns true if the model::Job is running, i.e.
although outwith this PR a change to
* Returns <code>true</code> if the {@link omero.model.Job} is
* running. I.e. has an attached {@link omero.model.Process}.
would make for a neater index entry.
|
b7d9005#diff-32cd3b746a391445c25fd6e8c5f25621R120 needs the return value wrapping in a code block. |
| * <code>false</code> is expected. | ||
| * | ||
| * See "read-only caveat" under {@link RawPixelsStore} | ||
| * See "Read-only caveat" under {@link RawPixelsStore} |
There was a problem hiding this comment.
For some reason I am not seeing this change in the rendered docs. But regardless of that does this change need to be made elsewhere in this file? Line 270 onwards has a few occurrences.
|
@ximenesuk: pushed 2 commits addressing most of the formatting issues. |
|
@ximenesuk: happy with the last changes? |
| /** | ||
| * Returns <code>true</code> if the {@link omero.model.Job} is | ||
| * running, i.e. has an attached {@link omero.model.Process}. | ||
| * running, I.e. has an attached process. |
There was a problem hiding this comment.
If the comma after 'running' stays then it should be 'i.e.' (i.e. lower case I)
|
@ximenesuk/@jburel: I have a local branch to tackle the three last classes of this epic work - see https://trello.com/c/JQ9AcNa2/77-copy-ome-api-documentation-to-omero-api. Worth fixing it on the last PR? |
|
Let's merge this PR, @ximenesuk minor edit can be done in the next PR. |
4 participants
See https://trello.com/c/KLCaZX4X/19-copy-ome-api-documentation-to-omero-api
Follow-up of #4547, #4569 and #4578, 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-slice2html or use the published CI documentation or OMERO.docs* artifacts. Check the links are all working and the method parameters match.