Updated comments [HFP-277]

improved-embed-and-download
Paal Joergensen 2016-12-16 11:38:47 +01:00
parent 526d7ddd7e
commit a1e68d212b
2 changed files with 24 additions and 16 deletions

View File

@ -2488,9 +2488,8 @@ class H5PCore {
/** /**
* Determine display options visibility and value on edit * Determine display options visibility and value on edit
* *
* @method getDisplayOptionsForEdit * @param int $disable
* @param [int] $disable * @return array
* @return [Array]
*/ */
public function getDisplayOptionsForEdit($disable = NULL) { public function getDisplayOptionsForEdit($disable = NULL) {
$display_options = []; $display_options = [];
@ -2519,7 +2518,6 @@ class H5PCore {
/** /**
* Helper function used to figure out embed & download behaviour * Helper function used to figure out embed & download behaviour
* *
* @method setDisplayOptionOverrides
* @param string $option_name * @param string $option_name
* @param H5PPermission $permission * @param H5PPermission $permission
* @param int $id * @param int $id
@ -2543,11 +2541,10 @@ class H5PCore {
/** /**
* Determine display option visibility when viewing H5P * Determine display option visibility when viewing H5P
* *
* @method getDisplayOptionsForView * @param int $display_options
* @param [int] $display_options * @param int $id Might be content id or user id.
* @param [int] $id Might be content id or user id.
* Depends on what the platform needs to be able to determine permissions. * Depends on what the platform needs to be able to determine permissions.
* @return [Array] * @return array
*/ */
public function getDisplayOptionsForView($disable, $id) { public function getDisplayOptionsForView($disable, $id) {
$display_options = $this->getDisplayOptionsAsArray($disable); $display_options = $this->getDisplayOptionsAsArray($disable);
@ -2570,9 +2567,8 @@ class H5PCore {
/** /**
* Convert display options as single byte to array * Convert display options as single byte to array
* *
* @method getDisplayOptionsAsArray * @param int $disable
* @param [int] $disable * @return array
* @return [Array]
*/ */
private function getDisplayOptionsAsArray($disable) { private function getDisplayOptionsAsArray($disable) {
return array( return array(

View File

@ -60,10 +60,22 @@ H5P.ActionBar = (function ($, EventDispatcher) {
hasActions = true; hasActions = true;
} }
/**
* Returns a reference to the dom element
*
* @method getDOMElement
* @return {H5P.jQuery}
*/
self.getDOMElement = function () { self.getDOMElement = function () {
return $actions; return $actions;
}; };
/**
* Does the actionbar contain actions?
*
* @method hasActions
* @return {Boolean}
*/
self.hasActions = function () { self.hasActions = function () {
return hasActions; return hasActions;
} }