WordPress.org

Plugin Directory

Changeset 435225


Ignore:
Timestamp:
09/08/11 14:20:19 (3 years ago)
Author:
GaryJ
Message:

Documentation improvements.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • genesis-admin-bar-plus/trunk/genesis-admin-bar-plus.php

    r434905 r435225  
    33 * Main plugin file. The plugin adds resources links related the Genesis Theme to the admin bar. 
    44 * 
    5  * @package GenesisAdminBarPlus 
    6  * @author  Gary Jones 
     5 * @package     GenesisAdminBarPlus 
     6 * @author      Gary Jones 
    77 * 
    88 * Plugin Name: Genesis Admin Bar Plus 
     
    2424 * gabp-debug as a querystring parameter to enable it. 
    2525 * 
    26  * @since 1.1 
     26 * @since 1.1.0 
    2727 */ 
    2828//define ( 'GABP_DEBUG', true ); 
     
    3232 * present in WordPress 3.1 and above. 
    3333 * 
    34  * @since 1.0 
     34 * @since 1.0.0 
    3535 */ 
    3636class Genesis_Admin_Bar_Plus { 
     
    6868     * The translation gettext domain for the plugin. 
    6969     * 
    70      * @since 1.0 
     70     * @since 1.0.0 
    7171     * 
    7272     * @var string Translation domain 
     
    7777     * Holds copy of instance, so other plugins can remove our hooks. 
    7878     * 
    79      * @since 1.0 
     79     * @since 1.0.0 
    8080     * @link  http://core.trac.wordpress.org/attachment/ticket/16149/query-standard-format-posts.php 
    8181     * @link  http://twitter.com/#!/markjaquith/status/66862769030438912 
     
    8888     * Constructor. 
    8989     * 
    90      * @since 1.0 
     90     * @since 1.0.0 
    9191     */ 
    9292    function __construct() { 
     
    101101    } 
    102102 
     103    /** 
     104     * Plugin set up on init. 
     105     * 
     106     * @since 1.0.0 
     107     */ 
    103108    function init() { 
    104109 
     
    131136     * are active. 
    132137     * 
    133      * @since 1.0 
     138     * @since 1.0.0 
    134139     */ 
    135140    function set_default_menu_items() { 
     
    388393     * Recursive function. Private. 
    389394     * 
    390      * @since  1.1 
     395     * @since  1.1.0 
    391396     * 
    392397     * @param  string $id Menu item ID 
     
    435440     * Helper function to sort the menu items by position. Private. 
    436441     * 
    437      * @since 1.0 
    438      * @todo  Try and find some way of sorting children after parent ID first 
     442     * @since 1.0.0 
    439443     */ 
    440444    function _sort( $a, $b ) { 
     
    456460     * filter. 
    457461     * 
    458      * @since 1.0 
     462     * @since 1.0.0 
    459463     * @uses  Genesis_Admin_Bar_Plus::sort() Helper function for uasort() 
    460464     * @uses  Genesis_Admin_Bar_Plus_Menu::get_items() Return default menu items 
     
    508512     *   add_theme_support( 'gabp-support-pretty-young-thing' ); 
    509513     * 
    510      * @since  1.0 
     514     * @since  1.0.0 
    511515     * 
    512516     * @return array Array of support boards. 
     
    578582     * returns false. 
    579583     * 
    580      * @since  1.0 
     584     * @since  1.0.0 
    581585     * 
    582586     * @param  string $name Lowercase, hyphen-spaced theme name, e.g. family-tree. 
     
    601605     * are non-critical. 
    602606     * 
    603      * @since 1.0 
     607     * @since 1.0.0 
    604608     */ 
    605609    function style() { 
     
    669673     * Can be activated by uncommenting the line near the top of this file. 
    670674     * 
    671      * @since  1.1 
     675     * @since  1.1.0 
    672676     * 
    673677     * @return boolean 
     
    686690 * Container for the menu items. 
    687691 * 
    688  * @since 1.0 
     692 * @since 1.0.0 
    689693 */ 
    690694class Genesis_Admin_Bar_Plus_Menu { 
     
    700704     * Assign the menu item to the array using the ID as the key. Public. 
    701705     * 
    702      * @since 1.0 
     706     * @since 1.0.0 
    703707     * 
    704708     * @param string $id Menu item identifier 
     
    714718     * Retrieve single menu item. 
    715719     * 
    716      * @since  1.1 
     720     * @since  1.1.0 
    717721     * 
    718722     * @param  string $id Menu item identifier 
     
    730734     * Edit the menu item arguments, merging with the existing values. Public. 
    731735     * 
    732      * @since 1.0 
     736     * @since 1.0.0 
    733737     * 
    734738     * @param string $id Menu item identifier 
     
    744748     * Remove the menu item from the array using the ID as the key. Public. 
    745749     * 
    746      * @since 1.0 
     750     * @since 1.0.0 
    747751     * 
    748752     * @param string $id Menu item identifier 
     
    758762     * Return the array of menu items. Public. 
    759763     * 
    760      * @since  1.0 
     764     * @since  1.0.0 
    761765     * 
    762766     * @return array All menu items 
Note: See TracChangeset for help on using the changeset viewer.