Comments (1)
As the wiki-doc says: this tag is to "describe the property in the
constructor's comment"
[http://code.google.com/p/jsdoc-toolkit/wiki/DocExamples]
So properties are intended to be placed in constructor's doc comment. You
actually
_can_ add them to doc comment for an object but the template doesn't display it
(I've
modified the latest version of the htm template in the repository so that it
now does
show object properties) but you should note that the idea of @property is to be
a
light-weight version of a full doc comment -- and it describes a property OF
something, not the property itself. So your example should be rewritten;
/**
status codes for operations
@property {number} success Returns 0 for successful operation
@property {number} success Returns -1 for a failure
*/
var status = {
success : 0,
failure : -1
}
or, alternatively
/**
status codes for operations
*/
var status = {
/**
* 0 for successful operation
* @type number
*/
success : 0,
/**
* -1 for a failure
* @type number
*/
failure : -1
}
depending on how important you think the "success" and "failure" objects are
(whether
they merit their own full doc comments, or just a mention in the parent's doc
comment).
Original comment by micmath
on 13 Jul 2007 at 10:05
- Changed state: Fixed
- Added labels: Type-Enhancement
- Removed labels: Type-Defect
from jsdoc-toolkit.
Related Issues (20)
- @exports does not export to another symbol's prototype properly HOT 3
- Assignment of a function to a prior declared variable incorrectly considered global HOT 2
- Aliased items are replaced with the first matching exported variable, even if it is not a full match. HOT 1
- Missing semi-colons in TokenReader prevent use of rhino 1.7R3 HOT 1
- Missing semicolon in TokenReader.js, line 17 HOT 1
- Private variables in anonymous function declared as constructor not exported
- Special characters in type expressions are not escaped properly in HTML output
- publishSrcHilite
- Better app/frame/Link.js
- Multiline comment may break the generated doc if it starts with a slash HOT 1
- Notice on front page makes it look like this project is dead. HOT 1
- support: best way to document input objects HOT 1
- removed extra pasted text
- Spelling correction
- Patch for /wiki/TagThrows.wiki
- Getting Started/Introduction missing
- File Index and _global_
- page https://code.google.com/p/jsdoc-toolkit/wiki/TagType does not contain type's descriptions
- can't find way to document code with closure
- uninitialized field documnetation not shown in output
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from jsdoc-toolkit.