b5002fb46b
chore(doc-gen): capture docs for modules from comments Closes #1258 docs(*): add module description jsdoc tags docs(*): add @public tag to public modules chore(doc-gen): fix overview-dump template The template was referencing an invalid property chore(doc-gen): use `@exportedAs` and `@public` rather than `@publicModule` This commit refactors how we describe components that are re-exported in another module. For example the "public" modules like `angular/angular` and `angular/annotations` are public but they only re-export components from "private" modules. Previously, you must apply the `@publicModule` tag to a component that was to be re-exported. Applying this tag caused the destination module to become public. Now, you specify that a module is public by applying the `@public` tag and then you can "re-export" components to other modules by applying the `@exportedAs` giving the name of the module from which the component will be re-exported. tag. This tag can be used multiple times on a single component, allowing the component to be exported on multiple modules. docs(*): rename `@publicModule` to `@exportedAs` The `@publicModule` dgeni tag has been replaced by the `@exportedAs` dgeni tag on components that are to be re-exported on another module. Closes #1290
44 lines
744 B
HTML
44 lines
744 B
HTML
{% include "lib/paramList.html" -%}
|
|
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<title></title>
|
|
<style>
|
|
h2 {
|
|
padding-left: 20px;
|
|
}
|
|
h3 {
|
|
padding-left: 50px;
|
|
}
|
|
h4 {
|
|
padding-left: 60px;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
|
|
|
|
<h1>Modules</h1>
|
|
|
|
{% for module in doc.modules %}
|
|
|
|
<h2>{$ module.id $}
|
|
{%- if module.public %} (public){% endif %}</h2>
|
|
|
|
{% for export in module.exports %}
|
|
<h3>{$ export.name $}</h3>
|
|
|
|
{%- if export.constructorDoc %}
|
|
<h4>{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.params) $}</h4>
|
|
{% endif -%}
|
|
{%- for member in export.members %}
|
|
<h4>{$ member.name $}{$ paramList(member.params) $}</h4>
|
|
{% endfor %}
|
|
|
|
{% endfor %}
|
|
|
|
{% endfor %}
|
|
|
|
</body>
|
|
</html>
|