Fix header of getObjectAnnotations to include new signatures

ome · May 15, 2013 · 99aa64e · 99aa64e
1 parent edbe8a8
commit 99aa64e
Showing 1 changed file with 15 additions and 8 deletions.
diff --git a/components/tools/OmeroM/src/annotations/getObjectAnnotations.m b/components/tools/OmeroM/src/annotations/getObjectAnnotations.m
@@ -1,23 +1,30 @@
 function annotations = getObjectAnnotations(session, annotationType, parentType, ids, varargin)
 % GETOBJECTANNOTATIONS Retrieve annotations of a given type associated with an object
 %
-%    files = getObjectAnnotations(session, annotationType, parentType, ids)
+%    anns = getObjectAnnotations(session, annotationType, parentType, ids)
 %    returns all annotations of type annotationType linked to the object of
 %    type parentType and identifiers ids owned by the session user.
 %
-%    files = getObjectAnnotations(session, annotationType, parentType, ids,
+%    anns = getObjectAnnotations(session, annotationType, parentType,
+%    parents) returns all annotations of type annotationType linked to the
+%    input parent objects of type parentType owned by the session user.
+%
+%    anns = getObjectAnnotations(session, annotationType, parentType, ids,
 %    'include', include) only returns annotations with the input namespace.
 %
-%    files = getObjectAnnotations(session, annotationType, parentType, ids,
+%    anns = getObjectAnnotations(session, annotationType, parentType, ids,
 %    'exclude', exclude) excludes annotations with the input namespace.
 %
 %    Examples:
 %
-%        anns = getObjectAnnotations(session, annotationType, parentType, ids)
-%        anns = getObjectAnnotations(session, annotationType, parentType, ids,...
-%        'include', include)
-%        anns = getObjectAnnotations(session, annotationType, parentType, ids,...
-%        'exclude', exclude)
+%        anns = getObjectAnnotations(session, annotationType, parentType,
+%        ids)
+%        anns = getObjectAnnotations(session, annotationType, parentType,
+%        parents)
+%        anns = getObjectAnnotations(session, annotationType, parentType,
+%        ids, 'include', include)
+%        anns = getObjectAnnotations(session, annotationType, parentType,
+%        ids, 'exclude', exclude)
 %
 % See also: GETIMAGEFILEANNOTATIONS, GETIMAGETAGANNOTATIONS,
 % GETIMAGECOMMENTANNOTATIONS