add docs, process PR feedback

This commit is contained in:
Art Lowel
2020-02-20 11:00:43 +01:00
parent f7f6600806
commit dea6638c1f
43 changed files with 225 additions and 91 deletions

View File

@@ -40,7 +40,7 @@ export class TaskObject extends DSpaceObject implements CacheableObject {
action: string;
/**
* The HALLinks for this TaskObject
* The {@link HALLink}s for this TaskObject
*/
@deserialize
_links: {
@@ -52,21 +52,21 @@ export class TaskObject extends DSpaceObject implements CacheableObject {
/**
* The EPerson for this task
* Will be undefined unless the eperson HALLink has been resolved.
* Will be undefined unless the eperson {@link HALLink} has been resolved.
*/
@link(EPERSON)
eperson?: Observable<RemoteData<EPerson>>;
/**
* The Group for this task
* Will be undefined unless the group HALLink has been resolved.
* Will be undefined unless the group {@link HALLink} has been resolved.
*/
@link(GROUP)
group?: Observable<RemoteData<Group>>;
/**
* The WorkflowItem for this task
* Will be undefined unless the workflowitem HALLink has been resolved.
* Will be undefined unless the workflowitem {@link HALLink} has been resolved.
*/
@link(WorkflowItem.type)
workflowitem?: Observable<RemoteData<WorkflowItem>> | WorkflowItem;