Skip to content

Instantly share code, notes, and snippets.

@peter-mw
Forked from mvriel/gist:3822861
Last active August 29, 2015 13:58
Show Gist options
  • Save peter-mw/9978125 to your computer and use it in GitHub Desktop.
Save peter-mw/9978125 to your computer and use it in GitHub Desktop.
/**
* Example_Class is a sample class for demonstrating PHPDoc
*
* Example_Class is a class that has no real actual code, but merely
* exists to help provide people with an understanding as to how the
* various PHPDoc tags are used.
*
* Example usage:
* if (Example_Class::example()) {
* print "I am an example.";
* }
*
* @package Example
* @author David Sklar <david@example.com>
* @author Adam Trachtenberg <adam@example.com>
* @version $Revision: 1.3 $
* @access public
* @see http://www.example.com/pear
*/
<?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())
{
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment