chore(doc-gen): render optional members correctly

petebacondarwin · petebacondarwin · commit ef3cc8e6eb46 · 2015-07-03T09:00:20.000+01:00
Partially Closes angular#2849
diff --git a/docs/angular.io-package/templates/class.template.html b/docs/angular.io-package/templates/class.template.html
@@ -31,7 +31,7 @@
 
 {%- for member in doc.members %}{% if not member.private %}
   .l-sub-section
-    h3 {$ member.name $}
+    h3 {$ member.name $}{% if member.optional %}?{% endif %}
 
     {% if member.parameters %}
     pre.prettyprint
diff --git a/docs/dgeni-package/mocks/readTypeScriptModules/interfaces.ts b/docs/dgeni-package/mocks/readTypeScriptModules/interfaces.ts
@@ -0,0 +1,4 @@
+export interface MyInterface {
+  optionalProperty? : string,
+  (param: string) : string
+}
diff --git a/docs/dgeni-package/processors/readTypeScriptModules.js b/docs/dgeni-package/processors/readTypeScriptModules.js
@@ -212,6 +212,10 @@ module.exports = function readTypeScriptModules(tsParser, readFilesProcessor, mo
       memberDoc.returnType = getReturnType(typeChecker, memberSymbol);
     }
 
+    if(memberSymbol.flags & ts.SymbolFlags.Optional) {
+      memberDoc.optional = true;
+    }
+
     return memberDoc;
   }
 
diff --git a/docs/dgeni-package/processors/readTypeScriptModules.spec.js b/docs/dgeni-package/processors/readTypeScriptModules.spec.js
@@ -45,6 +45,22 @@ describe('readTypeScriptModules', function() {
   });
 
 
+  describe('interfaces', function() {
+
+    it('should mark optional properties', function() {
+      processor.sourceFiles = [ 'interfaces.ts'];
+      var docs = [];
+      processor.$process(docs);
+
+      var moduleDoc = docs[0];
+      var exportedInterface = moduleDoc.exports[0];
+      var member = exportedInterface.members[0];
+      expect(member.name).toEqual('optionalProperty');
+      expect(member.optional).toEqual(true);
+    });
+  });
+
+
   describe('ordering of members', function() {
     it('should order class members in order of appearance (by default)', function() {
       processor.sourceFiles = ['orderingOfMembers.ts'];
diff --git a/docs/dgeni-package/templates/class.template.html b/docs/dgeni-package/templates/class.template.html
@@ -23,7 +23,9 @@ <h1 id="constructor" class="name">{$ doc.constructorDoc.name $}{$ paramList(doc.
 
 {%- for member in doc.members %}{% if not member.private %}
   <section class="member">
-    <h1 id="{$ member.name $}" class="name">{$ member.name $}{$ paramList(member.params) $}</h1>
+    <h1 id="{$ member.name $}" class="name">
+      {$ member.name $}{% if member.optional %}?{% endif %}{$ paramList(member.params) $}
+    </h1>
     {% marked %}
       {$ member.description $}
     {% endmarked %}
diff --git a/docs/dgeni-package/templates/type-definition.template.html b/docs/dgeni-package/templates/type-definition.template.html
@@ -29,6 +29,7 @@
   {%- for member in export.members -%}
     {$ commentBlock(member, 5) $}
     {$ member.name $}
+    {%- if member.optional %}?{% endif -%}
     {%- if member.parameters %}({% for param in member.parameters %}{$ param $}{% if not loop.last %}, {% endif %}{% endfor %}){%- endif %}
     {%- if member.returnType %}: {$ member.returnType $}{%- else -%}: any{% endif -%}
     ;

Original file line number	Diff line number	Diff line change
`@@ -212,6 +212,10 @@ module.exports = function readTypeScriptModules(tsParser, readFilesProcessor, mo`
`212`	`212`	`memberDoc.returnType = getReturnType(typeChecker, memberSymbol);`
`213`	`213`	`}`
`214`	`214`
	`215`	`+ if(memberSymbol.flags & ts.SymbolFlags.Optional) {`
	`216`	`+ memberDoc.optional = true;`
	`217`	`+ }`
	`218`	`+`
`215`	`219`	`return memberDoc;`
`216`	`220`	`}`
`217`	`221`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@`
`29`	`29`	`{%- for member in export.members -%}`
`30`	`30`	`{$ commentBlock(member, 5) $}`
`31`	`31`	`{$ member.name $}`
	`32`	`+ {%- if member.optional %}?{% endif -%}`
`32`	`33`	`{%- if member.parameters %}({% for param in member.parameters %}{$ param $}{% if not loop.last %}, {% endif %}{% endfor %}){%- endif %}`
`33`	`34`	`{%- if member.returnType %}: {$ member.returnType $}{%- else -%}: any{% endif -%}`
`34`	`35`	`;`