archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

Tweaked schema to match recent changes to @description and @returns type.

Browse Source
This commit is contained in:
Michael Mathews 2010-12-18 12:26:15 +00:00
parent f9d07621d8
commit 3f0b393b0e
2 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
jsdoc.jar Normal file
View File

Binary file not shown.

25
modules/jsdoc/schema.js
View File

@ -24,7 +24,7 @@ exports.jsdocSchema = {
"type": "string",
"maxItems": 1
},
"desc": { // a description
"description": { // a description
"type": "string",
"optional": true,
"maxItems": 1
@ -70,9 +70,18 @@ exports.jsdocSchema = {
"maxItems": 1
},
"extends": { // the path to another constructor
"type": "string",
"type": ["string", "array"],
"optional": true,
"maxItems": 1
"items": {
"type": "string"
}
},
"fires": { // the path to another doc object
"type": ["string", "array"],
"optional": true,
"items": {
"type": "string"
}
},
"requires": { // the symbol being documented requires another symbol
"type": ["string", "array"],
@ -126,7 +135,7 @@ exports.jsdocSchema = {
"type": "string"
}
},
"desc": { // a description of the thrown value
"description": { // a description of the thrown value
"type": "string",
"optional": true
}
@ -138,13 +147,13 @@ exports.jsdocSchema = {
"type": "object",
"properties": {
"type": { // what is the type of the value returned?
"type": "array",
"type": ["string", "array"],
"optional": true,
"items": {
"type": "string"
}
},
"desc": { // a description of the returned value
"description": { // a description of the returned value
"type": "string",
"optional": true
}
@ -158,7 +167,7 @@ exports.jsdocSchema = {
"type": "object",
"properties": {
"type": { // what are the types of value expected for this parameter?
"type": "array",
"type": ["string", "array"],
"optional": true,
"items": {
"type": "string"
@ -181,7 +190,7 @@ exports.jsdocSchema = {
"name": { // what name does this parameter have within the function?
"type": "string"
},
"desc": { // a description of the parameter
"description": { // a description of the parameter
"type": "string",
"optional": true
}