Merge pull request #45 from novalis/dturner/ivar-comments

Generate output for instance variable comments

Author: johnhaley81

generate/lib/generated_data.js

@@ -27,7 +27,7 @@ var generatedData = function(path, missingTestsPath) {
     var missingTests = fs.readJsonSync(missingTestsPath);
   }
 
-  generatedJSON.forEach(function(item) {
+    generatedJSON.forEach(function(item) {
     switch (item.type) {
       case 'class':
       case 'struct':
@@ -83,7 +83,10 @@ var generatedData = function(path, missingTestsPath) {
           }
         });
         item.fields.forEach(function(field) {
-          obj.fields[field.jsFunctionName] = field.jsClassName;
+          obj.fields[field.jsFunctionName] = {
+              'type': field.jsClassName,
+              'description' : field.comments
+          };
         });
         break;
       case 'enum':

generate/lib/write_api_docs.js

@@ -293,15 +293,15 @@ var writeApiDocs = function(apiData, path) {
 
     if (Object.keys(data.fields).length) {
       pageBody += "## <a name=\"ivars\"></a>Instance Variables\n\n";
-      pageBody += "| Variable | Type |\n";
-      pageBody += "| --- | --- |\n";
+      pageBody += "| Variable | Type | Description |\n";
+      pageBody += "| --- | --- | --- |\n";
 
       homeBody += "| Instance Variables |  |\n";
       homeBody += "| --- | ---: |\n";
 
       Object.keys(data.fields).sort().forEach(function(obj) {
         homeBody += "| " + linkToEntry("<span>" + item + "#</span>" + obj, item, obj) + " |  |\n";
-        pageBody += "| <a name=\"" + obj + "\"></a>" + obj + " | " + data.fields[obj] + " |\n";
+        pageBody += "| <a name=\"" + obj + "\"></a>" + obj + " | " + data.fields[obj].type + " | " + (data.fields[obj].description || '') + " |\n";
       });
 
       pageBody += "\n";