michaeluno / admin-page-framework

development/factory/admin_page/_model/AdminPageFramework_ImportOptions.php

Doc Comments +5 added lines

@@ -89,6 +89,11 @@
         return $vData;
         
     }
+
+    /**
+     * @param string $vData
+     * @param string $sFormatType
+     */
     public function formatImportData( &$vData, $sFormatType=null ) {
         
         $sFormatType = isset( $sFormatType ) ? $sFormatType : $this->getFormatType();

development/factory/admin_page/_model/delegate/AdminPageFramework_Model__FormEmailHandler.php

Doc Comments +1 added lines

@@ -25,6 +25,7 @@
     /**
      * Sets up properties.
      * @since       3.6.3
+     * @param AdminPageFramework_Model_Form $oFactory
      */
     public function __construct( $oFactory ) {
        

development/factory/admin_page/_model/delegate/AdminPageFramework_Model__FormSubmission.php

Doc Comments +6 added lines

@@ -26,6 +26,7 @@ 
     /**
      * Sets up hooks and properties.
      * @since       3.6.3
+     * @param AdminPageFramework_Model_Form $oFactory
      */
     public function __construct( $oFactory, $aSavedData, $aArguments, $aSectionsets, $aFieldsets ) {
        
@@ -250,6 +251,9 @@ 
          * Do the 'submit_...' actions.
          * 
          * @internal
+         * @param null|string $_sSubmitSectionID
+         * @param null|string $_sPressedFieldID
+         * @param null|string $_sPressedInputID
          * @return      void
          * @since       3.5.3
          * @since       3.6.3       Moved from `AdminPageFramework_Validation`.
@@ -296,6 +300,8 @@ 
          * Do the 'submit_after_...' actions.
          * 
          * @internal
+         * @param null|string $_sSubmitSectionID
+         * @param null|string $_sPressedFieldID
          * @return      void
          * @since       3.5.3
          * @since       3.6.3       Moved from `AdminPageFramework_Validation`.

development/factory/admin_page/_model/delegate/AdminPageFramework_Model__FormSubmission_Base.php

Doc Comments +1 added lines

@@ -79,6 +79,7 @@
      * @since       3.5.3
      * @since       3.6.3       Moved from `AdminPageFramework_Form_Model_Validation_Option`.
      * @internal
+     * @param boolean $bIsInputEmtpy
      * @return      void
      * @remark      Accessed from some of the parent/child classes.
      */

development/factory/admin_page/_view/AdminPageFramework_View__PageRenderer.php

Doc Comments +1 added lines

@@ -28,6 +28,7 @@
     /**
      * Sets up properties.
      * @since       3.6.3
+     * @param AdminPageFramework_View_Page $oFactory
      */
     public function __construct( $oFactory, $sPageSlug, $sTabSlug ) {
        

development/factory/admin_page/_view/AdminPageFramework_View__PageRenderer__PageHeadingTabs.php

Doc Comments +2 added lines

@@ -60,6 +60,7 @@ 
          * @since       3.3.1       Moved from `AdminPageFramework_Page`.
          * @since       3.5.3       Deprecated the `$aOutput` parameter.
          * @since       3.6.3       Moved from `AdminPageFramework_Page_View`. Changed the name from `_getPageHeadingTabs()`.
+         * @param string $sTag
          * @return      string      the output of page heading tabs.
          */
         private function _getOutput( $aPage, $sTag ) {
@@ -100,6 +101,7 @@ 
              * @internal
              * @since       3.5.3
              * @since       3.6.3       Moved from `AdminPageFramework_Page_View`.
+             * @param string $sTag
              * @return      string      the HTML page heading tab navigation bar output.
              */
             private function _getPageHeadingtabNavigationBar( array $aPages, $sTag, $sCurrentPageSlug ) {

development/factory/admin_page/_view/AdminPageFramework_View__PageRenderer__ScreenIcon.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
     }
         /**
          * @since       3.6.3
-         * @return      boolean
+         * @return      boolean|null
          */
         private function _isScreenIconVisible() {
             

development/factory/widget/AdminPageFramework_Widget_Factory.php

Doc Comments +1 added lines

@@ -23,6 +23,7 @@
      * Sets up internal properties.
      * 
      * @since       3.2.0
+     * @param AdminPageFramework_Widget_Model $oCaller
      * @return      void
      */
 	public function __construct( $oCaller, $sWidgetTitle, array $aArguments=array() ) {

development/factory/_common/_abstract/_controller/AdminPageFramework_Resource_Base.php

Doc Comments +4 added lines

@@ -232,6 +232,8 @@ 
      * @remark      The meta box class may be instantiated multiple times so prevent echoing the same styles multiple times.
      * @parameter   string      $sIDPrefix   The id selector embedded in the script tag.
      * @parameter   string      $sClassName  The class name that identify the call group. This is important for the meta-box class because it can be instantiated multiple times in one particular page.
+     * @param string $sIDPrefix
+     * @param string $sClassName
      */
     protected function _printCommonStyles( $sIDPrefix, $sClassName ) {
 
@@ -315,6 +317,8 @@ 
      * @remark      The meta box class may be instantiated multiple times so prevent echoing the same styles multiple times.
      * @parametr    string      $sIDPrefix      The id selector embedded in the script tag.
      * @parametr    string      $sClassName     The class name that identify the call group. This is important for the meta-box class because it can be instantiated multiple times in one particular page.
+     * @param string $sIDPrefix
+     * @param string $sClassName
      */
     protected function _printCommonScripts( $sIDPrefix, $sClassName ) {