From 7924e6d1fb4a104ab3cc03c775d5918cd20100e5 Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Tue, 28 Jan 2014 16:50:35 +0100 Subject: [PATCH] fixed apidoc context for markdown rendering --- extensions/apidoc/helpers/Markdown.php | 4 ++++ extensions/apidoc/templates/html/views/constSummary.php | 2 +- extensions/apidoc/templates/html/views/eventSummary.php | 2 +- extensions/apidoc/templates/html/views/methodSummary.php | 2 +- extensions/apidoc/templates/html/views/propertySummary.php | 2 +- extensions/apidoc/templates/html/views/seeAlso.php | 2 +- 6 files changed, 9 insertions(+), 5 deletions(-) diff --git a/extensions/apidoc/helpers/Markdown.php b/extensions/apidoc/helpers/Markdown.php index 5ea0b603b7..ee12af8d2f 100644 --- a/extensions/apidoc/helpers/Markdown.php +++ b/extensions/apidoc/helpers/Markdown.php @@ -34,6 +34,10 @@ class Markdown extends \yii\helpers\Markdown */ public static function process($content, $context = null) { + if (is_string($context)) { + $context = static::$renderer->context->getType($context); + } + $content = trim(parent::process($content, [])); if (!strncmp($content, '

', 3) && substr($content, -4, 4) == '

') { $content = substr($content, 3, -4); diff --git a/extensions/apidoc/templates/html/views/constSummary.php b/extensions/apidoc/templates/html/views/constSummary.php index 129f9a81da..620b1de15b 100644 --- a/extensions/apidoc/templates/html/views/constSummary.php +++ b/extensions/apidoc/templates/html/views/constSummary.php @@ -33,7 +33,7 @@ ArrayHelper::multisort($constants, 'name'); definedBy != $type->name ? ' class="inherited"' : '' ?> id="name ?>"> name ?> value ?> - shortDescription . "\n" . $constant->description, $type) ?> + shortDescription . "\n" . $constant->description, $constant->definedBy) ?> context->typeLink($constant->definedBy) ?> diff --git a/extensions/apidoc/templates/html/views/eventSummary.php b/extensions/apidoc/templates/html/views/eventSummary.php index f8abe0b338..e905510484 100644 --- a/extensions/apidoc/templates/html/views/eventSummary.php +++ b/extensions/apidoc/templates/html/views/eventSummary.php @@ -34,7 +34,7 @@ ArrayHelper::multisort($events, 'name'); context->subjectLink($event) ?> context->typeLink($event->types) ?> - shortDescription, $type) ?> + shortDescription, $event->definedBy) ?> since)): ?> (available since version since; ?>) diff --git a/extensions/apidoc/templates/html/views/methodSummary.php b/extensions/apidoc/templates/html/views/methodSummary.php index f628a2886f..b5224924f2 100644 --- a/extensions/apidoc/templates/html/views/methodSummary.php +++ b/extensions/apidoc/templates/html/views/methodSummary.php @@ -37,7 +37,7 @@ foreach($methods as $method): ?> visibility == 'protected' || !$protected && $method->visibility != 'protected'): ?> definedBy != $type->name ? ' class="inherited"' : '' ?> id="name ?>()"> context->subjectLink($method, $method->name.'()') ?> - shortDescription, $type) ?> + shortDescription, $method->definedBy) ?> context->typeLink($method->definedBy, $type) ?> diff --git a/extensions/apidoc/templates/html/views/propertySummary.php b/extensions/apidoc/templates/html/views/propertySummary.php index e67219a4d2..923d5ca1a8 100644 --- a/extensions/apidoc/templates/html/views/propertySummary.php +++ b/extensions/apidoc/templates/html/views/propertySummary.php @@ -38,7 +38,7 @@ foreach($properties as $property): ?> definedBy != $type->name ? ' class="inherited"' : '' ?> id="name ?>"> context->subjectLink($property) ?> context->typeLink($property->types) ?> - shortDescription, $type) ?> + shortDescription, $property->definedBy) ?> context->typeLink($property->definedBy) ?> diff --git a/extensions/apidoc/templates/html/views/seeAlso.php b/extensions/apidoc/templates/html/views/seeAlso.php index 9990714f5f..e25c63c803 100644 --- a/extensions/apidoc/templates/html/views/seeAlso.php +++ b/extensions/apidoc/templates/html/views/seeAlso.php @@ -25,7 +25,7 @@ if (empty($see)) {

See Also

    -
  • context->context->getType($object->definedBy)) ?>
  • +
  • definedBy) ?>