WP_CLI

DocParser::get_param_desc() │ public │ WP-CLI 1.0

Get the description for a given parameter.

Method of the class: DocParser{}

No Hooks.

Return

String.

Usage

$DocParser = new DocParser();
$DocParser->get_param_desc( $key );
$key(string) (required)
Parameter's key.

DocParser::get_param_desc() code WP-CLI 2.8.0-alpha

wp-cli/php/WP_CLI/DocParser.php 
public function get_param_desc( $key ) {

	if ( preg_match( "/\[?--{$key}=.+\n: (.+?)(\n|$)/", $this->doc_comment, $matches ) ) {
		return $matches[1];
	}

	return '';
}