From a1e68d212b907c58aa5e300cafa3cadeb0e4d771 Mon Sep 17 00:00:00 2001 From: Paal Joergensen Date: Fri, 16 Dec 2016 11:38:47 +0100 Subject: [PATCH] Updated comments [HFP-277] --- h5p.classes.php | 28 ++++++++++++---------------- js/h5p-action-bar.js | 12 ++++++++++++ 2 files changed, 24 insertions(+), 16 deletions(-) diff --git a/h5p.classes.php b/h5p.classes.php index d32ee12..7a71041 100644 --- a/h5p.classes.php +++ b/h5p.classes.php @@ -2488,9 +2488,8 @@ class H5PCore { /** * Determine display options visibility and value on edit * - * @method getDisplayOptionsForEdit - * @param [int] $disable - * @return [Array] + * @param int $disable + * @return array */ public function getDisplayOptionsForEdit($disable = NULL) { $display_options = []; @@ -2519,11 +2518,10 @@ class H5PCore { /** * Helper function used to figure out embed & download behaviour * - * @method setDisplayOptionOverrides - * @param string $option_name - * @param H5PPermission $permission - * @param int $id - * @param bool &$value + * @param string $option_name + * @param H5PPermission $permission + * @param int $id + * @param bool &$value */ private function setDisplayOptionOverrides($option_name, $permission, $id, &$value) { $behaviour = $this->h5pF->getOption($option_name, H5PDisplayOptionBehaviour::ALWAYS_SHOW); @@ -2543,11 +2541,10 @@ class H5PCore { /** * Determine display option visibility when viewing H5P * - * @method getDisplayOptionsForView - * @param [int] $display_options - * @param [int] $id Might be content id or user id. - * Depends on what the platform needs to be able to determine permissions. - * @return [Array] + * @param int $display_options + * @param int $id Might be content id or user id. + * Depends on what the platform needs to be able to determine permissions. + * @return array */ public function getDisplayOptionsForView($disable, $id) { $display_options = $this->getDisplayOptionsAsArray($disable); @@ -2570,9 +2567,8 @@ class H5PCore { /** * Convert display options as single byte to array * - * @method getDisplayOptionsAsArray - * @param [int] $disable - * @return [Array] + * @param int $disable + * @return array */ private function getDisplayOptionsAsArray($disable) { return array( diff --git a/js/h5p-action-bar.js b/js/h5p-action-bar.js index 8d30101..aba17e3 100644 --- a/js/h5p-action-bar.js +++ b/js/h5p-action-bar.js @@ -60,10 +60,22 @@ H5P.ActionBar = (function ($, EventDispatcher) { hasActions = true; } + /** + * Returns a reference to the dom element + * + * @method getDOMElement + * @return {H5P.jQuery} + */ self.getDOMElement = function () { return $actions; }; + /** + * Does the actionbar contain actions? + * + * @method hasActions + * @return {Boolean} + */ self.hasActions = function () { return hasActions; }