add some documentation in comments

This commit is contained in:
Uwe Steinmann 2021-08-30 19:34:38 +02:00
parent 48a0ca8cb9
commit 33c10fc1db

View File

@ -3404,6 +3404,8 @@ class SeedDMS_Core_DocumentContent extends SeedDMS_Core_Object { /* {{{ */
/** /**
* Return a list of all reviewers separated by individuals and groups * Return a list of all reviewers separated by individuals and groups
* This list will not take the review log into account. Therefore it
* can contain which has actually been deleted as a reviewer.
* *
* @return array|bool|null * @return array|bool|null
*/ */
@ -3433,7 +3435,7 @@ class SeedDMS_Core_DocumentContent extends SeedDMS_Core_Object { /* {{{ */
/** /**
* Get the current review status of the document content * Get the current review status of the document content
* The review status is a list of reviews and its current status * The review status is a list of reviewers and its current status
* *
* @param integer $limit the number of recent status changes per reviewer * @param integer $limit the number of recent status changes per reviewer
* @return array list of review status * @return array list of review status
@ -3582,6 +3584,8 @@ class SeedDMS_Core_DocumentContent extends SeedDMS_Core_Object { /* {{{ */
/** /**
* Return a list of all approvers separated by individuals and groups * Return a list of all approvers separated by individuals and groups
* This list will not take the approval log into account. Therefore it
* can contain which has actually been deleted as an approver.
* *
* @return array|bool|null * @return array|bool|null
*/ */
@ -3611,7 +3615,7 @@ class SeedDMS_Core_DocumentContent extends SeedDMS_Core_Object { /* {{{ */
/** /**
* Get the current approval status of the document content * Get the current approval status of the document content
* The approval status is a list of approvals and its current status * The approval status is a list of approvers and its current status
* *
* @param integer $limit the number of recent status changes per approver * @param integer $limit the number of recent status changes per approver
* @return array list of approval status * @return array list of approval status