PMPro phpDoc Examples

pmpro_phpdoc_examples.php

<?php
//phpDoc for new PMPro function
/**
 * A description of what the function does.
 *
 * @param {array, string, int, objext} {$variable_name} {Short description}
 * @return {array, string, int, mixed, object} {$variable_name} {Short description}
 *
 * {@internal Any To-Dos etc.}
 *
 * @since {next version of PMPro}
 */
function example_function($param1) {
	if($param1 == 'test')
		return true;
	else
		return false;
}

//phpDoc for new filter
/**
 * Description of the filter.
 *
 * @param {array, string, int, objext} {$variable_name} {Short description}
 * @param {array, string, int, objext} {$variable_name} {Short description}
 * 
 * @since 1.8.5
 */
$r = apply_filters('pmpro_example_filter', $r, $param);