loburets
10/2/2012 - 7:49 PM

Option arrays in PHPDoc

Option arrays in PHPDoc

<?php
/*
This code sample demonstrates several style for representing an option array with
the following fields: name, label, type_id, visible, default.

When designing this we should keep in mind that the option key may be represented 
by either a literal or a (class)constant. As such we mix and match those for 
illustrative purposes.   
*/

const NAME = "name";

/**
 * ...
 *
 * @param array $options [description]
 *     @option string  NAME      [description]
 *     @option string  "label"   [description]
 *     @option integer "type_id" [description]
 *     @option boolean "visible" [description]
 *     @option string  "default" [description]
 *
 * @return void
 */
function ryan_parman($options = array())
{

}

/**
 * ...
 *
 * @param mixed[] $options [description] {
 *     @type string  NAME      [description]
 *     @type string  "label"   [description]
 *     @type integer "type_id" [description]
 *     @type boolean "visible" [description]
 *     @type string  "default" [description]
 * }
 *
 * @return void
 */
function mike_van_riel($options = array())
{

}

/**
 * ...
 *
 * @param `Options` $options [description]
 * 
 * @struct Options {
 *     @type string  NAME      [description]
 *     @type string  "label"   [description]
 *     @type integer "type_id" [description]
 *     @type boolean "visible" [description]
 *     @type string  "default" [description]
 * }
 *
 * @return void
 */
function mike_van_riel2($options = array())
{

}