chore(not yet documented): remove placeholder to reduce noise
This commit is contained in:
parent
a9730db70d
commit
1ac2a42308
|
@ -98,6 +98,7 @@ input.api-filter {
|
||||||
|
|
||||||
.h2-api-docs {
|
.h2-api-docs {
|
||||||
font-size: 15px !important;
|
font-size: 15px !important;
|
||||||
|
line-height: 20px;
|
||||||
text-transform: uppercase !important;
|
text-transform: uppercase !important;
|
||||||
color: #78909C !important;
|
color: #78909C !important;
|
||||||
}
|
}
|
||||||
|
@ -137,6 +138,13 @@ input.api-filter {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.openParens {
|
||||||
|
margin-top: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.endParens {
|
||||||
|
margin-bottom: 20px !important;
|
||||||
|
}
|
||||||
|
|
||||||
p {
|
p {
|
||||||
|
|
||||||
|
|
|
@ -31,7 +31,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
|
||||||
div(flex="20" flex-xs="100")
|
div(flex="20" flex-xs="100")
|
||||||
h2(class="h2-api-docs") Class Overview
|
h2(class="h2-api-docs") Class Overview
|
||||||
div(flex="80" flex-xs="100")
|
div(flex="80" flex-xs="100")
|
||||||
code(class="no-bg api-doc-code") class {$ doc.name $} {
|
code(class="no-bg api-doc-code openParens") class {$ doc.name $} {
|
||||||
|
|
||||||
{% if doc.statics.length %}
|
{% if doc.statics.length %}
|
||||||
.div(layout="column")
|
.div(layout="column")
|
||||||
|
@ -58,7 +58,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
|
||||||
code(class="api-doc-code") {$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $}
|
code(class="api-doc-code") {$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $}
|
||||||
{% endif %}{% endfor %}
|
{% endif %}{% endfor %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
p.selector
|
p(class="selector endParens")
|
||||||
code(class="api-doc-code no-bg") }
|
code(class="api-doc-code no-bg") }
|
||||||
|
|
||||||
{% block additional %}
|
{% block additional %}
|
||||||
|
@ -71,8 +71,6 @@ include {$ relativePath(doc.path, '_util-fns') $}
|
||||||
:marked
|
:marked
|
||||||
{%- if doc.description.length > 2 %}
|
{%- if doc.description.length > 2 %}
|
||||||
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
|
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
|
||||||
{% else %}
|
|
||||||
*Not yet documented*
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
|
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
|
||||||
|
@ -94,9 +92,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
|
||||||
code(class="api-doc-code")
|
code(class="api-doc-code")
|
||||||
@{$ decorator.name $}{$ paramList(decorator.arguments) | indent(10, false) $}
|
@{$ decorator.name $}{$ paramList(decorator.arguments) | indent(10, false) $}
|
||||||
:marked
|
:marked
|
||||||
{%- if decorator.notYetDocumented %}
|
{%- if not decorator.notYetDocumented %}
|
||||||
*Not yet documented*
|
|
||||||
{% else %}
|
|
||||||
{$ decorator.description | indentForMarkdown(8) | trimBlankLines $}
|
{$ decorator.description | indentForMarkdown(8) | trimBlankLines $}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
@ -113,9 +109,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
|
||||||
code(class="api-doc-code").
|
code(class="api-doc-code").
|
||||||
{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.parameters) | indent(8, false) | trim $}
|
{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.parameters) | indent(8, false) | trim $}
|
||||||
:marked
|
:marked
|
||||||
{%- if doc.constructorDoc.notYetDocumented %}
|
{%- if not doc.constructorDoc.notYetDocumented %}
|
||||||
*Not yet documented*
|
|
||||||
{% else %}
|
|
||||||
{$ doc.constructorDoc.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
|
{$ doc.constructorDoc.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
@ -131,9 +125,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
|
||||||
code(class="api-doc-code").
|
code(class="api-doc-code").
|
||||||
{$ member.name $}{$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $}
|
{$ member.name $}{$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $}
|
||||||
:marked
|
:marked
|
||||||
{%- if member.notYetDocumented %}
|
{%- if not member.notYetDocumented %}
|
||||||
*Not yet documented*
|
|
||||||
{% else %}
|
|
||||||
{$ member.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
|
{$ member.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
@ -156,9 +148,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
|
||||||
{$ member.name $}{$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $}
|
{$ member.name $}{$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $}
|
||||||
|
|
||||||
:marked
|
:marked
|
||||||
{%- if member.notYetDocumented %}
|
{%- if not member.notYetDocumented %}
|
||||||
*Not yet documented*
|
|
||||||
{% else %}
|
|
||||||
{$ member.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
|
{$ member.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
|
|
||||||
|
|
|
@ -13,9 +13,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
|
||||||
code.
|
code.
|
||||||
export {$ doc.name $}(options : {@link {$ doc.decoratorType $} {$ doc.decoratorType | escape $}}){$ returnType(doc.returnType) $}
|
export {$ doc.name $}(options : {@link {$ doc.decoratorType $} {$ doc.decoratorType | escape $}}){$ returnType(doc.returnType) $}
|
||||||
:marked
|
:marked
|
||||||
{%- if doc.notYetDocumented %}
|
{%- if not doc.notYetDocumented %}
|
||||||
*Not yet documented*
|
|
||||||
{% else %}
|
|
||||||
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
|
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|
|
@ -13,9 +13,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
|
||||||
code.
|
code.
|
||||||
export {$ doc.name $}{$ paramList(doc.parameters) | indent(8, true) | trim $}{$ returnType(doc.returnType) $}
|
export {$ doc.name $}{$ paramList(doc.parameters) | indent(8, true) | trim $}{$ returnType(doc.returnType) $}
|
||||||
:marked
|
:marked
|
||||||
{%- if doc.notYetDocumented %}
|
{%- if not doc.notYetDocumented %}
|
||||||
*Not yet documented*
|
|
||||||
{% else %}
|
|
||||||
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
|
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|
|
@ -13,9 +13,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
|
||||||
code.
|
code.
|
||||||
export {$ doc.name $}{$ returnType(doc.returnType) $}
|
export {$ doc.name $}{$ returnType(doc.returnType) $}
|
||||||
:marked
|
:marked
|
||||||
{%- if doc.notYetDocumented %}
|
{%- if not doc.notYetDocumented %}
|
||||||
*Not yet documented*
|
|
||||||
{% else %}
|
|
||||||
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
|
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|
|
@ -23,6 +23,7 @@ module.exports = function addNotYetDocumentedProperty(EXPORT_DOC_TYPES, log, cre
|
||||||
}
|
}
|
||||||
|
|
||||||
if (doc.notYetDocumented) {
|
if (doc.notYetDocumented) {
|
||||||
|
// TODO: (ericjim) should I remove this?
|
||||||
log.warn(createDocMessage("Not yet documented", doc));
|
log.warn(createDocMessage("Not yet documented", doc));
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
Loading…
Reference in New Issue