diff --git a/aio/tools/transforms/angular-api-package/index.js b/aio/tools/transforms/angular-api-package/index.js
index 16c81e7c1e..9f769c9afc 100644
--- a/aio/tools/transforms/angular-api-package/index.js
+++ b/aio/tools/transforms/angular-api-package/index.js
@@ -94,7 +94,7 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
.config(function(splitDescription, EXPORT_DOC_TYPES) {
// Only split the description on the API docs
- splitDescription.docTypes = EXPORT_DOC_TYPES;
+ splitDescription.docTypes = EXPORT_DOC_TYPES.concat(['member', 'function-overload']);
})
.config(function(computePathsProcessor, EXPORT_DOC_TYPES, generateApiListDoc) {
@@ -130,6 +130,6 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
]);
convertToJsonProcessor.docTypes = convertToJsonProcessor.docTypes.concat(DOCS_TO_CONVERT);
postProcessHtml.docTypes = convertToJsonProcessor.docTypes.concat(DOCS_TO_CONVERT);
- autoLinkCode.docTypes = DOCS_TO_CONVERT.concat(['member']);
+ autoLinkCode.docTypes = DOCS_TO_CONVERT.concat(['member', 'function-overload']);
autoLinkCode.codeElements = ['code', 'code-example', 'code-pane'];
});
diff --git a/aio/tools/transforms/templates/api/lib/memberHelpers.html b/aio/tools/transforms/templates/api/lib/memberHelpers.html
index ffeab09194..c278c3c3fc 100644
--- a/aio/tools/transforms/templates/api/lib/memberHelpers.html
+++ b/aio/tools/transforms/templates/api/lib/memberHelpers.html
@@ -38,24 +38,35 @@
{%- endmacro -%}
{%- macro renderOverloadInfo(overload, cssClass, method) -%}
- {% if overload.description and (overload.description != method.description) %}{$ overload.description | marked $}{% endif %}
- {$ renderMemberSyntax(overload) $}
+{$ renderMemberSyntax(overload) $}
-
Parameters
- {$ params.renderParameters(overload.parameterDocs, cssClass + '-parameters', cssClass + '-parameter') $}
+{% if overload.shortDescription and (overload.shortDescription != method.shortDescription) %}
+
+ {$ overload.shortDescription | marked $}
+
{% endif %}
- {% if overload.type or overload.returns.type %}
- Returns
- {% marked %}`{$ (overload.type or overload.returns.type) $}`{% if overload.returns %}: {$ overload.returns.description $}{% endif %}{% endmarked %}
- {% endif %}
+Parameters
+{$ params.renderParameters(overload.parameterDocs, cssClass + '-parameters', cssClass + '-parameter') $}
- {% if overload.throws.length %}
- Throws
- {% for error in overload.throws %}
- {% marked %}`{$ (error.typeList or 'Error') $}` {$ error.description $}{% endmarked %}
- {% endfor %}
- {% endif %}
+{% if overload.type or overload.returns.type %}
+Returns
+{% marked %}`{$ (overload.type or overload.returns.type) $}`{% if overload.returns %}: {$ overload.returns.description $}{% endif %}{% endmarked %}
+{% endif %}
+
+
+{% if overload.throws.length %}
+Throws
+{% for error in overload.throws %}
+{% marked %}`{$ (error.typeList or 'Error') $}` {$ error.description $}{% endmarked %}
+{% endfor %}
+{% endif %}
+
+{% if overload.description and (overload.description != method.description) -%}
+
+ {$ overload.description | marked $}
+
+{%- endif %}
{%- endmacro -%}
{%- macro renderMethodDetail(method, cssClass) -%}
@@ -68,9 +79,9 @@
{% endif %}
{% endif %}
- {% if method.description %}
-
- {$ method.description | marked $}
+ {% if method.shortDescription %}
+
+ {$ method.shortDescription | marked $}
{% endif %}
{% if method.overloads.length == 0 %}
@@ -102,6 +113,11 @@
{% endif %}
+ {% if method.description %}
+
+ {$ method.description | marked $}
+
+ {% endif %}
{% endmacro -%}
@@ -135,6 +151,7 @@
{$ property.type | escape $}
{%- if (property.isGetAccessor or property.isReadonly) and not property.isSetAccessor %}Read-only. {% endif %}
+ {% if property.shortDescription %}{$ property.shortDescription | marked $}{% endif %}
{$ (property.description or property.constructorParamDoc.description) | marked $}
{% if property.constructorParamDoc %} Declared in constructor. {% endif %}