Fix for property tag being malformed.

This commit is contained in:
Michael Mathews 2012-09-20 01:21:13 +01:00
parent 3463a472a6
commit 20f8709463
3 changed files with 18 additions and 22 deletions

View File

@ -26,7 +26,7 @@ exports.attachTo = function(parser) {
}
e.doclet = newDoclet;
resolveProperties(newDoclet);
//resolveProperties(newDoclet);
});
// handles named symbols in the code, may or may not have a JSDoc comment attached
@ -129,7 +129,7 @@ exports.attachTo = function(parser) {
return false;
}
resolveProperties(newDoclet);
//resolveProperties(newDoclet);
if (!newDoclet.memberof) {
newDoclet.scope = 'global';
@ -172,19 +172,6 @@ exports.attachTo = function(parser) {
return false;
}
function resolveProperties(newDoclet) {
// find name and description from each property tag text
if (newDoclet.properties) {
for (var i = 0, len = newDoclet.properties.length; i < len; i++) {
var property = newDoclet.properties[i];
if (property.description) {
var parts = jsdoc.name.splitName(property.description);
property.name = parts.name;
property.description = parts.description;
}
}
}
}
function resolveProperties(newDoclet) {}
};

View File

@ -8,12 +8,6 @@ myobject = {
defaults: {
a: 1,
b: "Hit the light",
/**
* The c property of the defaults.
* @member
* @type {Boolean}
* @property {String} prop The property of c.
*/
c: true
}
};

View File

@ -0,0 +1,15 @@
describe("@property tag", function() {
var docSet = jasmine.getDocSetFromFile('test/fixtures/propertytag.js'),
myobject = docSet.getByLongname('myobject')[0];
it('When a symbol has an @property tag with a those properties appear in the parsed object.', function() {
expect(typeof myobject.properties).toEqual('object');
expect(myobject.properties.length).toEqual(3);
expect(myobject.properties[0].name).toEqual('defaults');
expect(myobject.properties[1].name).toEqual('defaults.a');
expect(myobject.properties[2].name).toEqual('defaults.b');
expect(myobject.properties[0].description).toEqual('The default values.');
expect(myobject.properties[0].type.names[0]).toEqual('Object');
});
});