feat(api): Add properties to detail page

Author: BrunnerLivio

compiler/api/index.ts

@@ -20,6 +20,8 @@ const nestjs = new Package('nestjs', [
   .processor(require('./processors/processPackages'))
   .processor(require('./processors/generateApiListDoc'))
   .processor(require('./processors/extractDecoratedClasses'))
+  .processor(require('./processors/processClassLikeMembers'))
+  .processor(require('./processors/filterContainedDocs'))
   .processor(require('./processors/test'))
 
   .config(function(readTypeScriptModules, tsParser) {

compiler/api/processors/filterContainedDocs.ts

@@ -0,0 +1,20 @@
+const docTypes = [
+  'member',
+  'function-overload',
+  'get-accessor-info',
+  'set-accessor-info',
+  'parameter'
+];
+
+/**
+ * Remove docs that are contained in (owned by) another doc
+ * so that they don't get rendered as files in themselves.
+ */
+module.exports = function filterContainedDocs() {
+  return {
+    $runAfter: ['extra-docs-added'],
+    $runBefore: ['computing-paths'],
+    $process: docs =>
+      docs.filter(doc => docTypes.indexOf(doc.docType) === -1)
+  };
+};

compiler/api/processors/processClassLikeMembers.ts

@@ -0,0 +1,59 @@
+/**
+ * A class like API doc contains members, but these can be either properties or method.
+ * Separate the members into two new collections: `doc.properties` and `doc.methods`.
+ */
+module.exports = function processClassLikeMembers() {
+  return {
+    $runAfter: ['filterContainedDocs'],
+    $runBefore: ['rendering-docs'],
+    $process(docs) {
+      docs.forEach(doc => {
+        if (doc.members) {
+          doc.properties = [];
+          doc.methods = [];
+          doc.members.forEach(member => {
+            if (isMethod(member)) {
+              doc.methods.push(member);
+              computeMemberDescription(member);
+            } else {
+              doc.properties.push(member);
+
+              if (!member.description) {
+                // Is this property defined as a constructor parameter e.g. `constructor(public property: string) { ... }`?
+                const constructorDoc = member.containerDoc.constructorDoc;
+                if (constructorDoc) {
+                  const matchingParameterDoc = constructorDoc.parameterDocs.filter(doc => doc.declaration === member.declaration)[0];
+                  member.constructorParamDoc = matchingParameterDoc;
+                }
+              }
+            }
+          });
+        }
+        if (doc.statics) {
+          doc.staticProperties = [];
+          doc.staticMethods = [];
+          doc.statics.forEach(member => {
+            if (isMethod(member)) {
+              doc.staticMethods.push(member);
+              computeMemberDescription(member);
+            } else {
+              doc.staticProperties.push(member);
+            }
+          });
+        }
+
+      });
+    }
+  };
+};
+
+function isMethod(doc) {
+  return doc.hasOwnProperty('parameters') && !doc.isGetAccessor && !doc.isSetAccessor;
+}
+
+function computeMemberDescription(member) {
+  if (!member.description && member.overloads) {
+    // Perhaps the description is on one of the overloads - take the first non-empty one
+    member.description = member.overloads.map(overload => overload.description).filter(description => !!description)[0];
+  }
+}

compiler/api/templates/class.template.html

@@ -3,7 +3,11 @@
 <h1>{$ doc.name $}</h1>
 <p>{$ doc.tags.description $} </p>
 
-<code language="ts" hideCopy="true" linenums="false">
-{% if doc.isAbstract %}abstract {% endif%}class {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} {{$ memberHelper.renderMembers(doc) $}
+<pre class="language-typescript">
+  <code class="language-typescript">
+{% if doc.isAbstract %}abstract {% endif%}class {$ doc.name $}{$ doc.typeParams | escape $}{$ memberHelper.renderHeritage(doc) $} {{$ memberHelper.renderMembers(doc) $}    
 }
-</code>
+  </code>
+</pre>
+
+{$ memberHelper.renderProperties(doc.properties, 'instance-properties', 'instance-property', 'Properties') $}

compiler/api/templates/includes/class-members.html

@@ -0,0 +1,14 @@
+{% import "lib/memberHelpers.html" as memberHelpers -%}
+
+{$ memberHelpers.renderProperties(doc.staticProperties, 'static-properties', 'static-property', 'Static properties') $}
+
+{$ memberHelpers.renderMethodDetails(versionInfo, doc.staticMethods, 'static-methods', 'static-method', 'Static methods') $}
+
+{% if doc.constructorDoc %}
+<h2>Constructor</h2>
+{$ memberHelpers.renderMethodDetail(versionInfo, doc.constructorDoc, 'constructor') $}
+{% endif %}
+
+{$ memberHelpers.renderProperties(doc.properties, 'instance-properties', 'instance-property', 'Properties') $}
+
+{$ memberHelpers.renderMethodDetails(versionInfo, doc.methods, 'instance-methods', 'instance-method', 'Methods') $}

compiler/api/templates/lib/memberHelpers.html

@@ -95,13 +95,6 @@ <h3>
     {% if method.shortDescription %}<tr>
       <td class="short-description">
         {$ method.shortDescription | marked $}
-        {%- if method.see.length %}
-        <p>See also:</p>
-        <ul>
-        {% for see in method.see %}
-          <li>{$ see | marked $}</li>{% endfor %}
-        </ul>
-        {% endif %}
       </td>
     </tr>{% endif %}
   {% if method.overloads.length == 0 %}
@@ -212,15 +205,8 @@ <h2>{$ headingText $}</h2>
           {%- if property.isSetAccessor and not property.isGetAccessor %}<span class='write-only-property'>Write-only.</span>{% endif %}
           {% if property.constructorParamDoc %} <span class='from-constructor'>Declared in constructor.</span>{% endif %}
           {% if property.shortDescription %}{$ property.shortDescription | marked $}{% endif %}
-          {$ (property.description or property.constructorParamDoc.description) | marked $}
-          {%- if property.see.length %}
-          <p>See also:</p>
-          <ul>
-          {% for see in property.see %}
-            <li>{$ see | marked $}</li>{% endfor %}
-          </ul>
-          {% endif %}
-          </td>
+          {$ (property.description or property.constructorParamDoc.description) | marked $}          
+        </td>
     </tr>
     {% endfor %}
     </tbody>