php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-29 22:21:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

fixed apidoc short description

Browse Source 
fixes #2797
This commit is contained in:
Carsten Brandt
2014-05-25 22:26:21 +02:00
parent e3ee1b0700
commit 85f49e0cfe
6 changed files with 27 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
extensions/apidoc/models/BaseDoc.php
View File

@@ -127,4 +127,20 @@ class BaseDoc extends Object
// $lines = file(YII_PATH . $this->sourcePath);
// return implode("", array_slice($lines, $this->startLine - 1, $this->endLine - $this->startLine + 1));
// }
public static function extractFirstSentence($text)
{
if (mb_strlen($text) > 4 && ($pos = mb_strpos($text, '.', 4, 'utf-8')) !== false) {
$sentence = mb_substr($text, 0, $pos + 1, 'utf-8');
if (mb_strlen($text) >= $pos + 3) {
$abbrev = mb_substr($text, $pos - 1, 4);
if ($abbrev === 'e.g.' || $abbrev === 'i.e.') { // do not break sentence after abbreviation
$sentence .= static::extractFirstSentence(mb_substr($text, $pos + 1));
}
}
return $sentence;
} else {
return $text;
}
}
}

6
extensions/apidoc/models/Context.php
View File

@@ -289,8 +289,7 @@ class Context extends Component
'isStatic' => false,
'type' => $method->returnType,
'types' => $method->returnTypes,
'shortDescription' => (($pos = strpos($method->return, '.')) !== false) ?
substr($method->return, 0, $pos) : $method->return,
'shortDescription' => BaseDoc::extractFirstSentence($method->return),
'description' => $method->return,
'getter' => $method
// TODO set default value
@@ -319,8 +318,7 @@ class Context extends Component
'isStatic' => false,
'type' => $param->type,
'types' => $param->types,
'shortDescription' => (($pos = strpos($param->description, '.')) !== false) ?
substr($param->description, 0, $pos) : $param->description,
'shortDescription' => BaseDoc::extractFirstSentence($param->description),
'description' => $param->description,
'setter' => $method
]);

6
extensions/apidoc/models/EventDoc.php
View File

@@ -39,11 +39,7 @@ class EventDoc extends ConstDoc
$this->type = $eventTag->getType();
$this->types = $eventTag->getTypes();
$this->description = ucfirst($eventTag->getDescription());
if (($pos = strpos($this->description, '.')) !== false) {
$this->shortDescription = substr($this->description, 0, $pos);
} else {
$this->shortDescription = $this->description;
}
$this->shortDescription = BaseDoc::extractFirstSentence($this->description);
unset($this->tags[$i]);
}
}

6
extensions/apidoc/models/PropertyDoc.php
View File

@@ -72,11 +72,7 @@ class PropertyDoc extends BaseDoc
$this->type = $tag->getType();
$this->types = $tag->getTypes();
$this->description = ucfirst($tag->getDescription());
if (($pos = strpos($this->description, '.')) !== false) {
$this->shortDescription = substr($this->description, 0, $pos + 1);
} else {
$this->shortDescription = $this->description;
}
$this->shortDescription = BaseDoc::extractFirstSentence($this->description);
}
}
if (empty($this->shortDescription) && $context !== null && !$hasInheritdoc) {

4
extensions/apidoc/templates/html/views/seeAlso.php
View File

@@ -5,6 +5,8 @@
* @var yii\web\View $this
*/
$type = $object instanceof \yii\apidoc\models\TypeDoc ? $object : $object->definedBy;
$see = [];
foreach ($object->tags as $tag) {
/** @var $tag phpDocumentor\Reflection\DocBlock\Tag\SeeTag */
@@ -13,7 +15,7 @@ foreach ($object->tags as $tag) {
if (strpos($ref, '://') === false) {
$ref = '[[' . $ref . ']]';
}
$see[] = rtrim(\yii\apidoc\helpers\ApiMarkdown::process($ref . ' ' . $tag->getDescription(), $object->definedBy, true), ". \r\n");
$see[] = rtrim(\yii\apidoc\helpers\ApiMarkdown::process($ref . ' ' . $tag->getDescription(), $type, true), ". \r\n");
}
}
if (empty($see)) {

6
extensions/apidoc/templates/html/views/type.php
View File

@@ -80,8 +80,10 @@ $renderer = $this->context;
</table>
<div id="classDescription">
<strong><?= ApiMarkdown::process($type->shortDescription, $type, true) ?></strong>
<p><?= ApiMarkdown::process($type->description, $type) ?></p>
<p><strong><?= ApiMarkdown::process($type->shortDescription, $type, true) ?></strong></p>
<?= ApiMarkdown::process($type->description, $type) ?>
<?= $this->render('seeAlso', ['object' => $type]) ?>
</div>
<a name="properties"></a>