Closed GoogleCodeExporter closed 8 years ago
This is entirely an issue with the template you are using, and you are
encouraged to modify/create a new/better template that lists symbols like
'goog.dom.foo' and 'goog.dom.bar' all on a single page if that is what you
want. However, the default template for JSDoc Toolkit expects each level of the
name to be documented separately, and will produce separate pages for each
level. So, in this case, a namespace named "goog", another namespace named
"dom" and a method named "foo" would yield three pages of documentation, one
for each level of namespacing. For example:
/**
@name goog
@namespace
*/
/**
@name goog.dom
@namespace
*/
/**
@name goog.dom.foo
@function
*/
Aside from the way the HTML pages are organized, it seems that you are pointing
out that the JSDoc used by Google is not 100% compatible with the JSDoc that
JSDoc Toolkit prefers. To that I can only say that Google has decided to create
their own dialect of JSDoc and did not consult anyone on this project or our
mailing list when they did so. Which is perfectly fine by me, but it's a little
unfair to then expect us to be compatible with whatever they eventually came up
with.
Original comment by micmath
on 15 Jul 2011 at 1:20
Original issue reported on code.google.com by
wil...@gmail.com
on 15 Jul 2011 at 10:32