michaeluno / admin-page-framework

development/factory/_common/form/_view/sectionset/AdminPageFramework_Form_View___Sectionsets.php

Doc Comments +4 added lines, -1 removed lines

@@ -165,6 +165,7 @@ 
     }
         /**
          * @since       3.7.0
+         * @param string $_sOutput
          * @return      string
          */
         private function _getSpinnerOutput( $_sOutput ) {
@@ -299,7 +300,7 @@ 
              * @param       array       $_aOutputs      Holds output elements - contents, section tab list, count of subsections.
              * @param       string      $_sSectionsID   The container id of sections.
              * @param       array       $_aSection
-             * @param       array       $_aFieldsInSections     A field-sets array already divided by section tab.
+             * @param       array       $aFieldsInSections     A field-sets array already divided by section tab.
              * @return      array       The updated sections table output array.
              */
             private function _getSectionsetTable( $_aOutputs, $_sSectionsID, array $_aSection, array $aFieldsInSections ) {
@@ -354,6 +355,7 @@ 
                  * Returns the output of sub-sections for repeatable and sortable sections.
                  * 
                  * @since       3.7.0
+                 * @param string $_sSectionsID
                  * @return      array
                  */
                 private function _getSubSections( $_aOutputs, $_sSectionsID, $_aSection, $_aSubSections ) {
@@ -500,6 +502,7 @@ 
              * @since       3.5.3
              * @since       3.6.0       Removed the `$sSectionID` parameter. Added the `$aSectionset` parameter.
              * @since       3.7.0       Moved from `AdminPageFramework_FormPart_Table`.
+             * @param string $sSectionsID
              * @return      string      The formatted sections table HTML output.
              */
             private function _getFormattedSectionsTablesOutput( array $aOutputs, $aSectionset, $sSectionsID, array $aCollapsible, $sSectionTabSlug ) {

development/factory/admin_page/AdminPageFramework_Controller_Menu.php

Doc Comments +3 added lines, -3 removed lines

@@ -74,6 +74,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 ) {
@@ -96,6 +98,7 @@ 
          * 
          * @since       2.0.0
          * @internal
+         * @param string $sMenuLabel
          * @return      void|string     Returns the associated slug string, if true.
          */ 
         private function _isBuiltInMenuItem( $sMenuLabel ) {
@@ -160,9 +163,6 @@ 
      * @since        3.0.0       Changed the scope to public.
      * @remark       The sub menu page slug should be unique because add_submenu_page() can add one callback per page slug.
      * @remark       Accepts variadic parameters; the number of accepted parameters are not limited to three.
-     * @param        array       $aSubMenuItem1      a first sub-menu array. A sub-menu array can be a link or a page. For the specifications of the array structures and its arguments, refer to the parameter section of the `addSubMenuItem()` method.
-     * @param        array       $aSubMenuItem2      (optional) a second sub-menu array.
-     * @param        array       $_and_more          (optional) a third and add items as many as necessary with next parameters.
      * @access       public
      * @return       void
      */     

development/factory/admin_page/AdminPageFramework_Controller_Page.php

Doc Comments +4 added lines, -37 removed lines

@@ -52,43 +52,6 @@ 
      * @since       2.0.0
      * @since       3.0.0     Changed the scope to public. Added page slug target support. 
      * @since       3.3.1       Moved from `AdminPageFramework_Page`.
-     * @param       array     $aTab1 The in-page tab array.
-     * <h4>In-Page Tab Array</h4>
-     * <ul>
-     *     <li>**page_slug** - (string) the page slug that the tab belongs to.</li>
-     *     <li>**tab_slug** -  (string) the tab slug. Non-alphabetical characters should not be used including dots(.) and hyphens(-).</li>
-     *     <li>**title** - (string) the title of the tab.</li>
-     *     <li>**order** - (optional, integer) the order number of the tab. The lager the number is, the lower the position it is placed in the menu.</li>
-     *     <li>**show_in_page_tab** - (optional, boolean) default: `true`. If this is set to `false`, the tab title will not be displayed in the tab navigation menu; however, it is still accessible from the direct URL.</li>
-     *     <li>**parent_tab_slug** - (optional, string) this needs to be set if the above `show_in_page_tab` argument is `false` so that the parent tab will be emphasized as active when the hidden page is accessed.</li>
-     *     <li>**url** - [3.5.0+] (optional, string) If this is set, the link url of the navigation tab will be this url. Use this to create link only tab.</li>
-     *     <li>**capability** - [3.6.0+] (optional, string) The capability level.</li>
-     *     <li>**if** - [3.6.0+] (optional, boolean) Whether the tab should be displayed or not.</li>
-     *     <li>style - [3.6.3+] (optional) (string|array) The path or url of a stylesheet which gets loaded in the head tag. Or inline CSS rules.
-     * When custom arguments need to be set such as whether it should be inserted in the footer, set an array holding the following arguments.
-     *          <ul>
-     *              <li>src - (required, string) the source url or path.</li>    
-     *              <li>handle_id - (optional, string) The handle ID of the stylesheet.</li>    
-     *              <li>dependencies - (optional, array) The dependency array.</li>    
-     *              <li>version - (optional, string) The stylesheet version number.</li>    
-     *              <li>media - (optional, string) the description of the field which is inserted into the after the input field tag.</li>    
-     *          </ul>
-     *     </li>
-     *     <li>script - [3.6.3+] (optional) (string|array) The path or url of a JavaScript script which gets loaded in the head tag. Or an inline JavaScript script.
-     * When custom arguments need to be set such as whether it should be inserted in the footer, set an array holding the following arguments.
-     *          <ul>
-     *              <li>src - (required, string) the source url or path.</li>    
-     *              <li>handle_id - (optional, string) The handle ID of the stylesheet.</li>    
-     *              <li>dependencies - (optional, array) The dependency array.</li>    
-     *              <li>version - (optional, string) The stylesheet version number.</li>    
-     *              <li>translation - (optional, array) an array holding translation key-value pairs.</li>    
-     *          </ul>
-     *     </li>
-     *     <li>show_debug_info - [3.8.8+] (optional, boolean) Whether to show debug information. If `WP_DEBUG` is false, the debug output will not be displayed. Default: `true`.</li>
-     * </ul>
-     * @param       array       $aTab2      Another in-page tab array.
-     * @param       array       $_and_more  (optional) Add in-page tab arrays as many as necessary to the next parameters.
-     * @param       string      $sPageSlug  (optional) If the passed parameter item is a string, it will be stored as the target page slug so that it will be applied to the next passed tab arrays as the page_slug element.
      * @remark      Accepts variadic parameters; the number of accepted parameters are not limited to three.
      * @remark      In-page tabs are different from page-heading tabs which is automatically added with page titles.  
      * @return      void
@@ -278,6 +241,10 @@ 
         /**
          * Sets a page property.
          * @since       3.6.0
+         * @param string $sPropertyName
+         * @param string $sPropertyKey
+         * @param boolean|string $mValue
+         * @param string $sPageSlug
          * @return      void
          */
         private function _setPageProperty( $sPropertyName, $sPropertyKey, $mValue, $sPageSlug ) {