Patch #3026

Kodoc: Support @link

Added by Chris Bandy almost 3 years ago. Updated almost 3 years ago.

Status:Closed Start date:06/28/2010
Priority:Normal Due date:
Assignee:Woody Gilk % Done:

100%
Category:Modules:Userguide
Target version:v3.0.7
Resolution:fixed Points:

Description

Kodoc can support @link to create hyperlinks to external resources.

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.link.pkg.html

0001-Parse-link-tags.-Fixes-3026.patch (803 Bytes) Chris Bandy, 06/29/2010 12:06 am

Associated revisions

Revision df003456
Added by Woody Gilk almost 3 years ago

Add @link PHPDoc tag parsing, fixes #3026

History

#1
Updated by Chris Bandy almost 3 years ago

This patch supports the single URL + optional description format.

#2
Updated by Woody Gilk almost 3 years ago

  • Tracker changed from Feature Request to Patch
  • Project changed from Userguide to Kohana v3.x
  • Assignee set to Woody Gilk

#3
Updated by Woody Gilk almost 3 years ago

  • Category set to Modules:Userguide
  • Status changed from New to Feedback
  • Target version set to v3.0.7

I'm not sure we need this, since Kodoc already use Markdown for parsing. Originally, it supported @link, but I removed because we use Markdown.

#4
Updated by Chris Bandy almost 3 years ago

When a class documented with Kodoc extends a class documented with PHPdoc the inherited docs appear in the API browser.

I found it really annoying that @link tags would immediately appear with a URL but not get converted to hyperlinks.

I agree that we shouldn't re-implement PHPdoc, but this one commonly used tag format is simple, easy to support and improves the usability of the API browser.

#5
Updated by Woody Gilk almost 3 years ago

  • Status changed from Feedback to Assigned

Good point, I didn't think of documenting non-Kohana classes.

#6
Updated by Woody Gilk almost 3 years ago

  • Status changed from Assigned to Closed
  • % Done changed from 0 to 100
  • Resolution set to fixed

Also available in: Atom PDF