Allow to specify an alternate caption when linking to other symbols, resolves #82

Author: sebastian-lenz

bin/typedoc.js

@@ -7252,14 +7252,19 @@ var td;
                 var _this = this;
                 return text.replace(/\[\[([^\]]+)\]\]/g, function (match, name) {
                     var reflection;
+                    var caption = name, splitAt = name.indexOf('|');
+                    if (splitAt !== -1) {
+                        caption = name.substr(splitAt + 1);
+                        name = name.substr(0, splitAt);
+                    }
                     if (_this.reflection) {
                         reflection = _this.reflection.findReflectionByName(name);
                     }
                     else if (_this.project) {
                         reflection = _this.project.findReflectionByName(name);
                     }
                     if (reflection && reflection.url) {
-                        return td.Util.format('<a href="%s">%s</a>', _this.getRelativeUrl(reflection.url), name);
+                        return td.Util.format('<a href="%s">%s</a>', _this.getRelativeUrl(reflection.url), caption);
                     }
                     else {
                         return match;

examples/basic/src/classes.ts

@@ -301,6 +301,9 @@ export class GenericClass<T extends BaseClass>
 }
 
 
+/**
+ * This a non generic class derived from a [[GenericClass|generic class]].
+ */
 export class NonGenericClass extends GenericClass<SubClassB>
 {
 

src/td/output/plugins/MarkedPlugin.ts

@@ -274,14 +274,20 @@ module td.output
         public parseReferences(text:string) {
             return text.replace(/\[\[([^\]]+)\]\]/g, (match:string, name:string) => {
                 var reflection:models.Reflection;
+                var caption = name, splitAt = name.indexOf('|');
+                if (splitAt !== -1) {
+                    caption = name.substr(splitAt + 1);
+                    name = name.substr(0, splitAt);
+                }
+
                 if (this.reflection) {
                     reflection = this.reflection.findReflectionByName(name);
                 } else if (this.project) {
                     reflection = this.project.findReflectionByName(name);
                 }
 
                 if (reflection && reflection.url) {
-                    return Util.format('<a href="%s">%s</a>', this.getRelativeUrl(reflection.url), name);
+                    return Util.format('<a href="%s">%s</a>', this.getRelativeUrl(reflection.url), caption);
                 } else {
                     return match;
                 }

test/renderer/specs/classes/_classes_.nongenericclass.html

@@ -70,6 +70,13 @@ <h1>Class NonGenericClass</h1>
 <div class="container container-main">
 	<div class="row">
 		<div class="col-8 col-content">
+			<section class="tsd-panel tsd-comment">
+				<div class="tsd-comment tsd-typography">
+					<div class="lead">
+						<p>This a non generic class derived from a <a href="_classes_.genericclass.html">generic class</a>.</p>
+					</div>
+				</div>
+			</section>
 			<section class="tsd-panel tsd-hierarchy">
 				<h3>Hierarchy</h3>
 				<ul class="tsd-hierarchy">