docs: differentiate between member properties and methods

scripts/docs/dgeni-config.js

@@ -22,6 +22,7 @@ module.exports = function(currentVersion) {
 .processor(require('./processors/jekyll'))
 .processor(require('./processors/remove-private-members'))
 .processor(require('./processors/hide-private-api'))
+.processor(require('./processors/collect-inputs-outputs'))
 
 // for debugging docs
 // .processor(function test(){

scripts/docs/processors/collect-inputs-outputs.js

@@ -0,0 +1,62 @@
+module.exports = function collectInputsOutputs() {
+  return {
+
+    $runBefore: ['rendering-docs'],
+    $process: function(docs) {
+      docs.forEach(function(doc) {
+
+        if (doc.members && doc.members.length) {
+          var members = [];
+          var inputs = [];
+          var outputs = [];
+
+          memberLoop:
+          for (var i in doc.members) {
+
+            // identify properties to differentiate from methods
+            if (typeof doc.members[i].parameters == 'undefined') {
+              doc.members[i].isProperty = true;
+            }
+
+            if (doc.members[i].decorators && doc.members[i].decorators.length) {
+
+              decoratorLoop:
+              for (var ii in doc.members[i].decorators) {
+
+                if (doc.members[i].decorators[ii].name == 'Input') {
+                  inputs.push(parseMember(doc.members[i]));
+                  continue memberLoop;
+                }
+                if (doc.members[i].decorators[ii].name == 'Output') {
+                  outputs.push(parseMember(doc.members[i]));
+                  continue memberLoop;
+                }
+              }
+              // not an input or output, must be a plain member
+              members.push(doc.members[i]);
+            } else {
+              members.push(doc.members[i]);
+            };
+          }
+
+          // update doc with pruned members list and add inputs and outputs
+          doc.members = members;
+          doc.inputs = inputs;
+          doc.outputs = outputs;
+        }
+
+        function parseMember(member) {
+          member.type = member.content.substring(
+            member.content.indexOf('{') + 1,
+            member.content.indexOf('}')
+          );
+          member.description = member.content.substring(
+            member.content.indexOf('}') + 1,
+            member.content.length
+          );
+          return member;
+        }
+      });
+    }
+  };
+};

scripts/docs/templates/common.template.html

@@ -56,11 +56,11 @@ docType: "<$ doc.docType $>"
 
 <@- macro functionSyntax(fn) @>
   <@- set sep = joiner(',&nbsp;') -@>
-<code><$ fn.name $>(<@- for param in fn.params @><$ sep() $>
+  <code><$ fn.name $><@- if not fn.isProperty @>(<@ endif -@><@- for param in fn.params @><$ sep() $>
   <@- if param.type.optional @>[<@ endif -@>
   <$ param.name $>
   <@- if param.type.optional @>]<@ endif -@>
-  <@ endfor @>)</code>
+  <@ endfor @><@- if not fn.isProperty @>)<@ endif -@></code>
   <@ if fn.alias @><small>(alias: <$ fn.alias $>)</small><@ endif @>
 <@ endmacro -@>
 
@@ -203,7 +203,7 @@ docType: "<$ doc.docType $>"
 <@ endif @>
 
 <@- if doc.statics.length -@>
-<h2>Static Methods</h2>
+<h2>Static Members</h2>
 <@- for method in doc.statics @><@ if not method.internal @>
 <div id="<$ method.name $>"></div>
 <h3><$ functionSyntax(method) $></h3>
@@ -244,7 +244,7 @@ docType: "<$ doc.docType $>"
 <!-- methods on the class -->
 <@- if doc.members and doc.members.length @>
 
-<h2>Instance Methods</h2>
+<h2>Instance Members</h2>
 <@- for method in doc.members @>
 
 <div id="<$ method.name $>"></div>