documentation checking

Author: jcheron

Ajax/bootstrap/html/HtmlModal.php

@@ -121,10 +121,10 @@ public function renderView(JsUtils $js,$initialController,$viewName, $params=arr
 	/**
 	 * render the content of $controller::$action and set the response to the modal content
 	 * @param JsUtils $js
-	 * @param string $title The panel title
 	 * @param Controller $initialControllerInstance
 	 * @param string $controllerName the controller name
 	 * @param string $actionName the action name
+	 * @param array $params
 	 */
 	public function forward(JsUtils $js,$initialControllerInstance,$controllerName,$actionName,$params=NULL){
 		$this->content=$js->forward($initialControllerInstance, $controllerName, $actionName,$params);

Ajax/bootstrap/html/base/HtmlNavElement.php

@@ -27,7 +27,7 @@ public function __construct($identifier,$tagName){
 
 	/**
 	 * Associate an ajax get to the elements, displayed in $targetSelector
-	 * $attr member is used to build each element url
+	 * $this->attr member is used to build each element url
 	 * @param string $targetSelector the target of the get
 	 * @param string $attr the html attribute used to build the elements url
 	 * @return HtmlNavElement

Ajax/common/Widget.php

@@ -259,12 +259,16 @@ public function setDefaultValueFunction($defaultValueFunction){
 		return $this;
 	}
 
+	/**
+	 * @param string|boolean $disable
+	 * @return string
+	 */
 	public function jsDisabled($disable=true){
 		return "$('#".$this->identifier." .ui.input').toggleClass('disabled',".$disable.");";
 	}
 
 	/**
-	 * @param unknown $caption
+	 * @param string $caption
 	 * @param callable $callback function($element)
 	 * @return \Ajax\common\html\HtmlDoubleElement
 	 */

Ajax/common/html/traits/BaseHtmlEventsTrait.php

@@ -4,6 +4,7 @@
 use Ajax\service\AjaxCall;
 use Ajax\common\components\SimpleExtComponent;
 use Ajax\service\Javascript;
+use Ajax\common\html\BaseHtml;
 
 /**
  * @author jc
@@ -24,6 +25,11 @@ public function addEvent($event, $jsCode, $stopPropagation=false, $preventDefaul
 		return $this->_addEvent($event, $jsCode);
 	}
 
+	/**
+	 * @param string $event
+	 * @param string $jsCode
+	 * @return BaseHtml
+	 */
 	public function _addEvent($event, $jsCode) {
 		if (array_key_exists($event, $this->_events)) {
 			if (is_array($this->_events[$event])) {
@@ -93,6 +99,14 @@ protected function _eventsOnCreate(JsUtils $js=NULL){
 		}
 	}
 
+	/**
+	 * @param string $operation
+	 * @param string $event
+	 * @param string $url
+	 * @param string $responseElement
+	 * @param array $parameters
+	 * @return BaseHtml
+	 */
 	public function _ajaxOn($operation, $event, $url, $responseElement="", $parameters=array()) {
 		$params=array ("url" => $url,"responseElement" => $responseElement );
 		$params=array_merge($params, $parameters);

Ajax/semantic/html/collections/HtmlBreadcrumb.php

@@ -63,9 +63,8 @@ public function __construct($identifier, $items=array(), $autoActive=true, $star
 
 	/**
 	 * Associate an ajax get to the breadcrumb elements, displayed in $targetSelector
-	 * $attr member is used to build each element url
+	 * $this->attr member is used to build each element url
 	 * @param string $targetSelector the target of the get
-	 * @param string $attr the html attribute used to build the elements url
 	 * @return HtmlBreadcrumbs
 	 */
 	public function autoGetOnClick($targetSelector) {

Ajax/semantic/html/collections/form/traits/CheckboxTrait.php

@@ -4,6 +4,7 @@
 
 use Ajax\semantic\html\base\constants\CheckboxType;
 use Ajax\semantic\html\modules\checkbox\AbstractCheckbox;
+use Ajax\semantic\html\collections\form\HtmlFormField;
 
 /**
  * @author jc
@@ -22,7 +23,7 @@ public function setType($checkboxType) {
 	 * Attach $this to $selector and fire $action
 	 * @param string $selector jquery selector of the associated element
 	 * @param string $action action to execute : check, uncheck or NULL for toggle
-	 * @return \Ajax\semantic\html\collections\form\AbstractHtmlFormRadioCheckbox
+	 * @return HtmlFormField
 	 */
 	public function attachEvent($selector, $action=NULL) {
 		return $this->getHtmlCk()->attachEvent($selector, $action);
@@ -31,7 +32,7 @@ public function attachEvent($selector, $action=NULL) {
 	/**
 	 * Attach $this to an array of $action=>$selector
 	 * @param array $events associative array of events to attach ex : ["#bt-toggle","check"=>"#bt-check","uncheck"=>"#bt-uncheck"]
-	 * @return \Ajax\semantic\html\collections\form\AbstractHtmlFormRadioCheckbox
+	 * @return HtmlFormField
 	 */
 	public function attachEvents($events=array()) {
 		return $this->getHtmlCk()->attachEvents($events);
@@ -55,7 +56,7 @@ public function getDataField(){
 	/**
 	 * Check the checkbox
 	 * @param boolean $value
-	 * @return \Ajax\semantic\html\collections\form\traits\CheckboxTrait
+	 * @return HtmlFormField
 	 */
 	public function setChecked($value=true){
 		if($value===true){

Ajax/semantic/html/collections/form/traits/FieldTrait.php

@@ -18,6 +18,9 @@ abstract public function addToProperty($name, $value, $separator=" ");
 	abstract public function addLabel($caption, $style="label-default", $leftSeparator=" ");
 	abstract public function addContent($content,$before=false);
 	abstract public function getField();
+	abstract public function getItem($index);
+	abstract public function getDataField();
+
 	public function setFocus() {
 		$this->getField()->addToProperty("class", State::FOCUS);
 	}

Ajax/semantic/html/content/HtmlListItem.php

@@ -33,7 +33,7 @@ protected function initContent($content){
 			}
 			if(isset($title)){
 				$this->setTitle($title,$desc);
-			}elseif (isset($header)===true){
+			}elseif (isset($header)){
 				$this->setTitle($header,$desc,"header");
 			}
 			if(isset($items)){

Ajax/semantic/html/content/table/HtmlTableContent.php

@@ -74,8 +74,12 @@ public function addRow($colCount) {
 		return $this->addItem($colCount);
 	}
 
+	/**
+	 * @param mixed $row
+	 * @return HtmlTR
+	 */
 	public function _addRow($row) {
-		$this->addItem($row);
+		return $this->addItem($row);
 	}
 
 	/**

Ajax/semantic/html/elements/HtmlButton.php

@@ -98,7 +98,7 @@ public function asSubmit() {
 
 	/**
 	 * Add and return a button label
-	 * @param string $caption
+	 * @param string $label
 	 * @param boolean $before
 	 * @param string $icon
 	 * @return \Ajax\semantic\html\elements\HtmlLabel