diff --git a/public/resources/css/module/_api.scss b/public/resources/css/module/_api.scss index d94cee7dfd..380ee52894 100644 --- a/public/resources/css/module/_api.scss +++ b/public/resources/css/module/_api.scss @@ -98,6 +98,7 @@ input.api-filter { .h2-api-docs { font-size: 15px !important; + line-height: 20px; text-transform: uppercase !important; color: #78909C !important; } @@ -137,6 +138,13 @@ input.api-filter { } } + .openParens { + margin-top: 15px; + } + + .endParens { + margin-bottom: 20px !important; + } p { diff --git a/tools/api-builder/angular.io-package/templates/class.template.html b/tools/api-builder/angular.io-package/templates/class.template.html index 81dce34619..7390604888 100644 --- a/tools/api-builder/angular.io-package/templates/class.template.html +++ b/tools/api-builder/angular.io-package/templates/class.template.html @@ -31,7 +31,7 @@ include {$ relativePath(doc.path, '_util-fns') $} div(flex="20" flex-xs="100") h2(class="h2-api-docs") Class Overview 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 %} .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) $} {% endif %}{% endfor %} {% endif %} - p.selector + p(class="selector endParens") code(class="api-doc-code no-bg") } {% block additional %} @@ -71,8 +71,6 @@ include {$ relativePath(doc.path, '_util-fns') $} :marked {%- if doc.description.length > 2 %} {$ doc.description | indentForMarkdown(6) | trimBlankLines $} - {% else %} - *Not yet documented* {% endif %} .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") @{$ decorator.name $}{$ paramList(decorator.arguments) | indent(10, false) $} :marked - {%- if decorator.notYetDocumented %} - *Not yet documented* - {% else %} + {%- if not decorator.notYetDocumented %} {$ decorator.description | indentForMarkdown(8) | trimBlankLines $} {% endif %} {% endfor %} @@ -113,9 +109,7 @@ include {$ relativePath(doc.path, '_util-fns') $} code(class="api-doc-code"). {$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.parameters) | indent(8, false) | trim $} :marked - {%- if doc.constructorDoc.notYetDocumented %} - *Not yet documented* - {% else %} + {%- if not doc.constructorDoc.notYetDocumented %} {$ doc.constructorDoc.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $} {% endif %} {% endif %} @@ -131,9 +125,7 @@ include {$ relativePath(doc.path, '_util-fns') $} code(class="api-doc-code"). {$ member.name $}{$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $} :marked - {%- if member.notYetDocumented %} - *Not yet documented* - {% else %} + {%- if not member.notYetDocumented %} {$ member.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $} {% endif %} @@ -156,9 +148,7 @@ include {$ relativePath(doc.path, '_util-fns') $} {$ member.name $}{$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $} :marked - {%- if member.notYetDocumented %} - *Not yet documented* - {% else %} + {%- if not member.notYetDocumented %} {$ member.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $} {% endif -%} diff --git a/tools/api-builder/angular.io-package/templates/decorator.template.html b/tools/api-builder/angular.io-package/templates/decorator.template.html index ee9ccc40ac..6d449814cf 100644 --- a/tools/api-builder/angular.io-package/templates/decorator.template.html +++ b/tools/api-builder/angular.io-package/templates/decorator.template.html @@ -13,9 +13,7 @@ include {$ relativePath(doc.path, '_util-fns') $} code. export {$ doc.name $}(options : {@link {$ doc.decoratorType $} {$ doc.decoratorType | escape $}}){$ returnType(doc.returnType) $} :marked - {%- if doc.notYetDocumented %} - *Not yet documented* - {% else %} + {%- if not doc.notYetDocumented %} {$ doc.description | indentForMarkdown(6) | trimBlankLines $} {% endif %} diff --git a/tools/api-builder/angular.io-package/templates/function.template.html b/tools/api-builder/angular.io-package/templates/function.template.html index c85c6a9ec8..00e29907de 100644 --- a/tools/api-builder/angular.io-package/templates/function.template.html +++ b/tools/api-builder/angular.io-package/templates/function.template.html @@ -13,9 +13,7 @@ include {$ relativePath(doc.path, '_util-fns') $} code. export {$ doc.name $}{$ paramList(doc.parameters) | indent(8, true) | trim $}{$ returnType(doc.returnType) $} :marked - {%- if doc.notYetDocumented %} - *Not yet documented* - {% else %} + {%- if not doc.notYetDocumented %} {$ doc.description | indentForMarkdown(6) | trimBlankLines $} {% endif %} diff --git a/tools/api-builder/angular.io-package/templates/var.template.html b/tools/api-builder/angular.io-package/templates/var.template.html index 6a9db8905d..b67006fe84 100644 --- a/tools/api-builder/angular.io-package/templates/var.template.html +++ b/tools/api-builder/angular.io-package/templates/var.template.html @@ -13,9 +13,7 @@ include {$ relativePath(doc.path, '_util-fns') $} code. export {$ doc.name $}{$ returnType(doc.returnType) $} :marked - {%- if doc.notYetDocumented %} - *Not yet documented* - {% else %} + {%- if not doc.notYetDocumented %} {$ doc.description | indentForMarkdown(6) | trimBlankLines $} {% endif %} diff --git a/tools/api-builder/docs-package/processors/addNotYetDocumentedProperty.js b/tools/api-builder/docs-package/processors/addNotYetDocumentedProperty.js index 67d7762a85..ed3b29b22b 100644 --- a/tools/api-builder/docs-package/processors/addNotYetDocumentedProperty.js +++ b/tools/api-builder/docs-package/processors/addNotYetDocumentedProperty.js @@ -23,6 +23,7 @@ module.exports = function addNotYetDocumentedProperty(EXPORT_DOC_TYPES, log, cre } if (doc.notYetDocumented) { + // TODO: (ericjim) should I remove this? log.warn(createDocMessage("Not yet documented", doc)); } });