Comments (4)
This probably does what you mean in JSDoc 3, but are you saying you would rather not have to document the "my" namespace on it's own?
/**
* Document me.
* @namespace my
*/
/**
* My special namespace
* @namespace my.namespace
*/
$namespace('my.namespace', /** @lends my.namespace **/ {
/**
* Foo - does something really neat...
*/
foo: function() {
}
});
from jsdoc.
That fixes the issue. I didn't realise that all namespaces in the chain had to be documented. I think that it would be beneficial for jsdoc to fill in the blanks with simple generic pages. A little like phpDoc does.
The information on (http://code.google.com/p/jsdoc-toolkit/wiki/TagNamespace) is confusing because it suggests that @namespace is only followed by a description, when in fact it is followed by the name of the namespace (which makes more sense to me).
Was this a specific change to jsdoc3 or an error in the jsdoc2 wiki?
from jsdoc.
You are correct, the @namespace name
syntax was added in JSDoc 3, and will be documented here (soon):
http://usejsdoc.org/tags-namespace.html
The difficulty with creating generic pages for undocumented parts of the chain is that, in JavaScript, those pages could refer to almost anything (class, namespace, module, even function or variable), and this gets tricky with very long chains and chains like @namespace foo.bar.Zop#ns
. In other words it's simple in the simple case, but there probably isn'y any good way to do it in the complex case. I do understand the desire to have something like that but on the other hand I don't particularly want to make it easy for people to skip documentation for things like root namespaces either.
from jsdoc.
Many thanks for your help. Keep up the great work with jsdoc3!
from jsdoc.
Related Issues (20)
- JSDoc does not correctly parse the default value of the property tag
- Does it work with unknown tags ? HOT 1
- Instance members starting with a hash are not documented correctly. HOT 1
- jsdoc.app page down HOT 1
- jsdoc fails when ES6 classes have private members (`#fieldname`)
- Mixin fields are documented twice on class declarations with a constructor HOT 1
- jsdoc for globalThis
- How to document properties with colon? HOT 2
- npmignore includes necessary `test` directory
- Filtering an output before generating documentation
- Tests fail on Node.js 20.10.0 (and maybe Node.js 20.x)
- Inline syntax HOT 9
- Description getting generated twice in the HTML HOT 1
- MetaMask
- Bug in nodeToValue conversion of object literals
- [Question] Documenting destructured function argument with rest parameter
- saltydb missing inner join used in default template HOT 4
- How do I read JSDocs?
- Bug: with option `-c` config file ends with `.cjs` is still treated as JSON
- BUG: Use object shorthand or index signatures being applied to JavaScript files
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.