oikai_reflect_descriptions() – Display the API descriptions

Description

Display the short description then the long description.

Usage

oikai_reflect_descriptions( $docblock );

Parameters

$docblock

( object ) required – the docBlock object

Returns

[tags:protected] => Array 
( 
[0] => @TODO: Handle markdown and other attempts at formatting the notes such as plain tables 
[1] => @TODO: Properly handle TODO's and links - these are stored separately from the long description! 
[2] => @param object $docblock - the docBlock object 
) 
 `  

Source

function oikai_reflect_descriptions( $docblock ) {
  h2( "Description" );
  //p( esc_html( $docblock->getShortDescription() ) );
  oikai_format_description( $docblock->getShortDescription() );
  //p( esc_html( $docblock->getLongDescription() ) );
  sp();
  oikai_format_description( $docblock->getLongDescription() );
  bw_echo( '</p>' );
  //bw_trace2( $docblock );
}