dbc95b75af
* All export members are now tagged if they have no documentation. * All exports are tagged if they and their members have no documentation. * The templates for these docs display the words "Not Yet Documented" if they are tagged. * The build creates a warning for each export that is not documented * The build generates a new file, `public/docs/ts/latest/api/overview-dump.html`, which lists all the modules, exports and members highlighting those that are not documented.
24 lines
598 B
HTML
24 lines
598 B
HTML
{% include "lib/githubLinks.html" -%}
|
|
{% include "lib/paramList.html" -%}
|
|
{% extends 'layout/base.template.html' %}
|
|
|
|
{% block body %}
|
|
include ../../_util-fns
|
|
.l-main-section
|
|
h2(class="variable export")
|
|
pre.prettyprint
|
|
code.
|
|
export {$ doc.name $}{$ returnType(doc.returnType) $}
|
|
|
|
p.location-badge.
|
|
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
|
|
defined in {$ githubViewLink(doc) $}
|
|
|
|
:marked
|
|
{%- if doc.notYetDocumented %}
|
|
*Not Yet Documented*
|
|
{% else %}
|
|
{$ doc.description | indentForMarkdown(4) | trimBlankLines $}
|
|
{% endif -%}
|
|
{% endblock %}
|