Skip to content

Commit

Permalink
Fix Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
ppouchin committed Dec 2, 2024
1 parent a66d5ae commit f1803f5
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 1 deletion.
11 changes: 10 additions & 1 deletion src/main/java/fr/igred/omero/Annotatable.java
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ default void link(BasicDataManager dm, Annotation... annotations)
*
* @param client The client handling the connection.
* @param annotations Annotations to add.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down Expand Up @@ -296,7 +297,7 @@ default List<String> getValues(BasicBrowser browser, String key)
* Returns all the ratings from the specified user IDs for this object.
*
* @param browser The data browser.
* @param userIds List of user IDs (can be null, i. e. all users).
* @param userIds List of user IDs (can be null, i.e. all users).
*
* @return See above.
*
Expand Down Expand Up @@ -331,6 +332,7 @@ default List<RatingAnnotation> getRatings(BasicBrowser browser)
*
* @param client The client handling the connection.
* @param rating The rating.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down Expand Up @@ -400,6 +402,7 @@ default void addTable(BasicDataManager dm, TableWrapper table)
* @param client The client handling the connection.
* @param table Table to add to the object.
* @param policy Whether older tables should be unlinked, deleted or deleted only if they become orphaned.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand All @@ -417,6 +420,7 @@ void addAndReplaceTable(C client, TableWrapper table, ReplacePolicy policy)
*
* @param client The client handling the connection.
* @param table Table to add to the object.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down Expand Up @@ -501,6 +505,7 @@ default long addFile(BasicDataManager dm, File file)
* @param client The client handling the connection.
* @param file File to add.
* @param policy Whether older files should be unlinked, deleted or deleted only if they become orphaned.
* @param <C> The type of the client.
*
* @return ID of the file created in OMERO.
*
Expand All @@ -520,6 +525,7 @@ long addAndReplaceFile(C client, File file, ReplacePolicy policy)
*
* @param client The client handling the connection.
* @param file File to add.
* @param <C> The type of the client.
*
* @return ID of the file created in OMERO.
*
Expand Down Expand Up @@ -556,6 +562,7 @@ List<FileAnnotation> getFileAnnotations(BasicBrowser browser)
* @param client The client handling the connection.
* @param annotation An annotation.
* @param <A> The type of the annotation.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand All @@ -573,6 +580,7 @@ void unlink(C client, A annotation)
* @param client The client handling the connection.
* @param annotations List of annotations
* @param <A> The type of the annotation.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down Expand Up @@ -623,6 +631,7 @@ List<Annotation> getAnnotations(BasicBrowser browser)
*
* @param client The client handling the connection.
* @param object Other annotated object to copy annotations from.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/fr/igred/omero/AnnotatableWrapper.java
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@ public List<RatingAnnotation> getRatings(BasicBrowser browser, List<Long> userId
*
* @param client The client handling the connection.
* @param rating The rating.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down Expand Up @@ -305,6 +306,7 @@ public int getMyRating(BasicBrowser browser)
* @param client The client handling the connection.
* @param table Table to add to the object.
* @param policy Whether older tables should be unlinked, deleted or deleted only if they become orphaned.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down Expand Up @@ -377,6 +379,7 @@ public TableWrapper getTable(BasicDataManager dm, Long fileId)
* @param client The client handling the connection.
* @param file File to add.
* @param policy Whether older files should be unlinked, deleted or deleted only if they become orphaned.
* @param <C> The type of the client.
*
* @return ID of the file created in OMERO.
*
Expand Down Expand Up @@ -495,6 +498,7 @@ void unlink(C client, Collection<A> annotations)
* @param client The client handling the connection.
* @param linkType The link type.
* @param childIds List of link child IDs.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down Expand Up @@ -523,6 +527,7 @@ protected <C extends BasicBrowser & BasicDataManager> void removeLinks(C client,
* @param client The client handling the connection.
* @param linkType The link type.
* @param childId Link child ID.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/fr/igred/omero/containers/Dataset.java
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,7 @@ default void addImage(BasicDataManager dm, Image image)
*
* @param client The client handling the connection.
* @param image Image to remove.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down Expand Up @@ -415,6 +416,7 @@ List<Long> importImage(ConnectionHandler conn, String path)
* @param client The client handling the connection.
* @param oldImages The list of old images to replace.
* @param newImage The new image.
* @param <C> The type of the client.
*
* @return The list of images that became orphaned once replaced.
*
Expand Down Expand Up @@ -460,6 +462,7 @@ List<Image> replaceImages(C client,
* @param client The client handling the connection.
* @param path Path to the image on the computer.
* @param policy Whether older images should be unlinked, deleted or deleted only if they become orphaned.
* @param <C> The type of the client.
*
* @return The list of IDs of the newly imported images.
*
Expand All @@ -480,6 +483,7 @@ List<Long> importAndReplaceImages(C client, String path, ReplacePolicy policy)
*
* @param client The client handling the connection.
* @param path Path to the image on the computer.
* @param <C> The type of the client.
*
* @return The list of IDs of the newly imported images.
*
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/fr/igred/omero/containers/DatasetWrapper.java
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ public List<Image> getImages(BasicBrowser browser)
*
* @param client The client handling the connection.
* @param image Image to remove.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down Expand Up @@ -231,6 +232,7 @@ public List<Long> importImage(ConnectionHandler conn, String path)
* @param client The client handling the connection.
* @param path Path to the image on the computer.
* @param policy Whether older images should be unlinked, deleted or deleted only if they become orphaned.
* @param <C> The type of the client.
*
* @return The list of IDs of the newly imported images.
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/fr/igred/omero/containers/Project.java
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ default Dataset addDataset(BasicDataManager dm, Dataset dataset)
*
* @param client The client handling the connection.
* @param dataset Dataset to remove.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ public Dataset addDataset(BasicDataManager dm, String name, String description)
*
* @param client The client handling the connection.
* @param dataset Dataset to remove.
* @param <C> The type of the client.
*
* @throws ServiceException Cannot connect to OMERO.
* @throws AccessException Cannot access data.
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/fr/igred/omero/core/Image.java
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,7 @@ default List<Folder> getFolders(ContainersBrowser browser)
* the ij library to use this function
*
* @param client The client handling the connection.
* @param <C> The type of the client.
*
* @return ImagePlus generated from the current image.
*
Expand All @@ -469,6 +470,7 @@ ImagePlus toImagePlus(C client)
* @param cBounds Array containing the C bounds from which the pixels should be retrieved.
* @param zBounds Array containing the Z bounds from which the pixels should be retrieved.
* @param tBounds Array containing the T bounds from which the pixels should be retrieved.
* @param <C> The type of the client.
*
* @return an ImagePlus from the ij library.
*
Expand All @@ -491,6 +493,7 @@ ImagePlus toImagePlus(C client,
*
* @param client The client handling the connection.
* @param roi The ROI.
* @param <C> The type of the client.
*
* @return an ImagePlus from the ij library.
*
Expand All @@ -510,6 +513,7 @@ ImagePlus toImagePlus(C client, ROI roi)
*
* @param client The client handling the connection.
* @param bounds The bounds.
* @param <C> The type of the client.
*
* @return an ImagePlus from the ij library.
*
Expand Down Expand Up @@ -586,6 +590,7 @@ default Color getChannelImportedColor(BasicBrowser browser, int index)
*
* @param client The client handling the connection.
* @param index Channel number.
* @param <C> The type of the client.
*
* @return Color of the channel.
*
Expand Down
1 change: 1 addition & 0 deletions src/main/java/fr/igred/omero/core/ImageWrapper.java
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,7 @@ public PixelsWrapper getPixels() {
* @param cBounds Array containing the C bounds from which the pixels should be retrieved.
* @param zBounds Array containing the Z bounds from which the pixels should be retrieved.
* @param tBounds Array containing the T bounds from which the pixels should be retrieved.
* @param <C> The type of the client.
*
* @return an ImagePlus from the ij library.
*
Expand Down

0 comments on commit f1803f5

Please sign in to comment.