Skip to content

Generate output for instance variable comments #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johnhaley81 merged 1 commit into from
Feb 7, 2017
Merged

Generate output for instance variable comments #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions generate/lib/generated_data.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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':
Expand Down Expand Up @@ -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':
Expand Down
6 changes: 3 additions & 3 deletions generate/lib/write_api_docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down