oikai_choose_desc() – Decide what to use for the "Description"

Description

Decide what to use for the "Description"

Usage

oikai_choose_desc( $docblock, $funcname );

Parameters

$docblock

( mixed ) required –

$funcname

( mixed ) required –

Returns

void

Source

File name: oik-shortcodes/admin/oik-apitype.php
Lines:

function oikai_choose_desc( $docblock, $funcname ) {
  $ld = $docblock->getLongDescription();
  $sd = $docblock->getShortDescription();
  if ( $ld ) {
    if ( $sd ) {
      $desc = $sd;
    } else {
      $desc = $ld; 
    }
  } else { 
    if ( $sd ) {
      $desc = $sd;
    } else {
      $desc = oikai_reverse_engineer_funcname( $funcname );
    }  
  }
  $desc = oikai_first_line( $desc );
  return( $desc );
}
 

 View on GitHub