chore(doc-gen): add docType info into _data.json files
This commit is contained in:
parent
608f35b4a7
commit
19274e744d
|
@ -44,7 +44,8 @@ module.exports = function addJadeDataDocsProcessor() {
|
|||
title: _.map(path.basename(doc.fileInfo.baseName).split('_'), function(part) {
|
||||
return titleCase(part);
|
||||
}).join(' '),
|
||||
intro: doc.description.replace('"', '\"').replace(/\s*(\r?\n|\r)\s*/g," ")
|
||||
intro: doc.description.replace('"', '\"').replace(/\s*(\r?\n|\r)\s*/g," "),
|
||||
docType: 'module'
|
||||
}];
|
||||
|
||||
// GET DATA FOR EACH PAGE (CLASS, VARS, FUNCTIONS)
|
||||
|
@ -53,6 +54,7 @@ module.exports = function addJadeDataDocsProcessor() {
|
|||
return {
|
||||
name: exportDoc.name + '-' + exportDoc.docType,
|
||||
title: exportDoc.name,
|
||||
docType: exportDoc.docType,
|
||||
varType: exportDoc.symbolTypeName && titleCase(exportDoc.symbolTypeName)
|
||||
};
|
||||
})
|
||||
|
|
|
@ -15,7 +15,7 @@ describe('addJadeDataDocsProcessor', function() {
|
|||
{
|
||||
docType: 'module',
|
||||
id: 'someModule',
|
||||
exports: [{ name: 'MyClass', docType: 'class'}],
|
||||
exports: [{ name: 'someObj', docType: 'var', symbolTypeName: 'MyClass'}],
|
||||
fileInfo: { baseName: 'x_y' },
|
||||
description: 'some description\nsecond line'
|
||||
}
|
||||
|
@ -29,7 +29,7 @@ describe('addJadeDataDocsProcessor', function() {
|
|||
originalDoc : docs[0],
|
||||
data : [
|
||||
{ name : 'index', title : 'X Y', intro : 'some description second line' },
|
||||
{ name : 'MyClass-class', title : 'MyClass', varType : undefined }
|
||||
{ name : 'someObj-var', title : 'someObj', varType : 'MyClass', docType: 'var' }
|
||||
] });
|
||||
});
|
||||
|
||||
|
@ -53,11 +53,11 @@ describe('addJadeDataDocsProcessor', function() {
|
|||
|
||||
expect(docs[1].data).toEqual([
|
||||
{ name : 'index', title : 'X Y', intro : 'some description second line' },
|
||||
{ name: 'Alpha-class', title: 'Alpha', varType : undefined },
|
||||
{ name: 'Beta-class', title: 'Beta', varType : undefined },
|
||||
{ name: 'Gamma-class', title: 'Gamma', varType : undefined },
|
||||
{ name: 'Mu-class', title: 'Mu', varType : undefined },
|
||||
{ name: 'Nu-class', title: 'Nu', varType : undefined }
|
||||
{ name: 'Alpha-class', title: 'Alpha', varType : undefined, docType: 'class' },
|
||||
{ name: 'Beta-class', title: 'Beta', varType : undefined, docType: 'class' },
|
||||
{ name: 'Gamma-class', title: 'Gamma', varType : undefined, docType: 'class' },
|
||||
{ name: 'Mu-class', title: 'Mu', varType : undefined, docType: 'class' },
|
||||
{ name: 'Nu-class', title: 'Nu', varType : undefined, docType: 'class' }
|
||||
]);
|
||||
|
||||
});
|
||||
|
|
|
@ -1,9 +1,14 @@
|
|||
{
|
||||
{%- for item in doc.data %}
|
||||
"{$ item.name $}" : {
|
||||
"title" : "{$ item.title $}"{% if item.intro %},
|
||||
"intro" : "{$ item.intro $}"{% endif %}{% if item.varType %},
|
||||
"varType" : "{$ item.varType $}"{% endif %}
|
||||
"title" : "{$ item.title $}",
|
||||
{%- if item.intro %}
|
||||
"intro" : "{$ item.intro $}",
|
||||
{%- endif %}
|
||||
{%- if item.varType %}
|
||||
"varType" : "{$ item.varType $}",
|
||||
{%- endif %}
|
||||
"docType": "{$ item.docType $}"
|
||||
}{% if not loop.last %},{% endif %}
|
||||
{% endfor -%}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue