michaeluno / admin-page-framework

development/factory/_abstract/utility/AdminPageFramework_RegisterClasses.php

Doc Comments +1 added lines

@@ -170,6 +170,7 @@
         
         /**
          * The recursive version of the glob() function.
+         * @param string $sPathPatten
          */
         protected function doRecursiveGlob( $sPathPatten, $nFlags=0, array $aExcludeDirs=array(), array $aExcludeDirNames=array() ) {
 

development/factory/_abstract/utility/base_utility/AdminPageFramework_Utility_String.php

Doc Comments +2 added lines, -2 removed lines

@@ -21,7 +21,7 @@ 
      * Converts non-alphabetic characters to underscore.
      * 
      * @since       2.0.0
-     * @return      string|null     The sanitized string.
+     * @return      string     The sanitized string.
      * @todo        Change the method name as it does not tell for what it will sanitized.
      * @todo        Examine why null needs to be returned.
      */ 
@@ -90,7 +90,7 @@ 
     /**
      * Returns the given string length.
      * @since       3.3.0
-     * @return      integer|null        Null if an array is given.
+     * @return      integer        Null if an array is given.
      */
     static public function getStringLength( $sString ) {
         return function_exists( 'mb_strlen' )

development/factory/_abstract/utility/base_utility/AdminPageFramework_Utility_SystemInformation.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
      * Returns an array of constants.
      * 
      * @since       3.4.6
-     * @param       array|string      $asCategory      The category key names of the returning array.
+     * @param       array|string      $asCategories      The category key names of the returning array.
      */
     static public function getDefinedConstants( $asCategories=null, $asRemovingCategories=null ) {
         

development/factory/_abstract/utility/base_utility/AdminPageFramework_Utility_URL.php

Doc Comments +2 added lines

@@ -23,6 +23,7 @@ 
      * 
      * @since       2.0.0
      * @since       3.5.7       Moved from `AdminPageFramework_Utility`.
+     * @param string $sQueryKey
      * @return      string|null
      */ 
     static public function getQueryValueInURLByKey( $sURL, $sQueryKey ) {
@@ -72,6 +73,7 @@ 
         /**
          * Returns the port suffix in the currently loading url.
          * @since       3.5.7
+         * @param boolean $_bSSL
          * @return      string
          */
         static private function _getURLPortSuffix( $_bSSL ) {

development/factory/_abstract/utility/wp_utility/AdminPageFramework_WPUtility_Page.php

Doc Comments +1 added lines

@@ -284,6 +284,7 @@
              * Checkes whether the passed base url name is of the admin index page.
              * @since       3.5.3
              * return       boolean      Whether the passed base url name is of the admin index page.
+             * @param string $sPageNow
              */
             static private function _isInAdminIndex( $sPageNow ) {
                 return in_array(

development/factory/admin_page/AdminPageFramework.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      * @since       2.0.0
      * @see         http://codex.wordpress.org/Roles_and_Capabilities
      * @see         http://codex.wordpress.org/I18n_for_WordPress_Developers#Text_Domains
-     * @param       array|integer|string    $aisOptionKey    (optional) specifies the option key name to store in the options table. If this is not set, the instantiated class name will be used as default. 
+     * @param       array|integer|string    $isOptionKey    (optional) specifies the option key name to store in the options table. If this is not set, the instantiated class name will be used as default. 
      * [3.5.9+] If an integer is given, a transient will be used. If an array of option key arguments is given, the argument values will be set to the framework properties.
      * - type - either `options_table` or `transient`.
      * - key - the option key or the transient key

development/factory/admin_page/AdminPageFramework_Controller.php

Doc Comments +6 added lines

@@ -142,6 +142,7 @@ 
      *     <li>**media** - (optional, string) the description of the field which is inserted into the after the input field tag.</li>
      *     <li>**attributes** - (optional, array) [3.3.0+] attributes array. `array( 'data-id' => '...' )`</li>
      * </ul>
+     * @param string $sSRC
      * @return      string      The style handle ID. If the passed url is not a valid url string, an empty string will be returned.
      */    
     public function enqueueStyle( $sSRC, $sPageSlug='', $sTabSlug='', $aCustomArgs=array() ) {
@@ -234,6 +235,7 @@ 
     * @param        string      the tagged HTML link text.
     * @param        string      (optional) another tagged HTML link text.
     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+    * @param string $sTaggedLinkHTML1
     * @access       public
     * @return       void
     */     
@@ -258,6 +260,9 @@ 
     * @param        string      the tagged HTML link text.
     * @param        string      (optional) another tagged HTML link text.
     * @param        string      (optional) add more as many as want by adding items to the next parameters.
+    * @param null|string $sTaggedLinkHTML1
+    * @param string $sTaggedLinkHTML2
+    * @param string $_and_more
     * @access       public
     * @return       void
     */    
@@ -274,6 +279,7 @@ 
      * 
      * @since       3.1.0
      * @since       3.3.1       Moved from `AdminPageFramework`.
+     * @param string $sLabel
      */  
     public function setPluginSettingsLinkLabel( $sLabel ) {
         $this->oProp->sLabelPluginSettingsLink = $sLabel;

development/factory/admin_page/AdminPageFramework_Controller_Form.php

Doc Comments -3 removed lines

@@ -153,9 +153,6 @@
     * @since        3.5.3       Removed the parameter declarations as they are caught with the func_get_args().
     * @access       public
     * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param        string      $sSectionID1        the section ID to remove.
-    * @param        string      $sSectionID2        (optional) another section ID to remove.
-    * @param        string      $_and_more          (optional) add more section IDs to the next parameters as many as necessary.
     * @return       void
     */    
     public function removeSettingSections( /* $sSectionID1=null, $sSectionID2=null, $_and_more=null */ ) {    

development/factory/admin_page/AdminPageFramework_Controller_Menu.php

Doc Comments +3 added lines

@@ -48,6 +48,8 @@ 
      *  <li>a base64-encoded SVG using a data URI, which will be colored to match the color scheme. This should begin with 'data:image/svg+xml;base64,'.</li>
      * </ul>
      * @param       string      (optional) the position number that is passed to the <var>$position</var> parameter of the <a href="http://codex.wordpress.org/Function_Reference/add_menu_page">add_menu_page()</a> function.
+     * @param string $sIcon16x16
+     * @param integer $iMenuPosition
      * @return      void
      */
     public function setRootMenuPage( $sRootMenuLabel, $sIcon16x16=null, $iMenuPosition=null ) {
@@ -70,6 +72,7 @@ 
          * 
          * @since       2.0.0
          * @internal
+         * @param string $sMenuLabel
          * @return      void|string Returns the associated slug string, if true.
          */ 
         private function _isBuiltInMenuItem( $sMenuLabel ) {