PlanetRubyOnRails - has_many :blogs, :through => :feeds::
with the public api docs), but as I continued to study the code the JsDoc Toolkit can do some really cool stuff and has made vast improvements since
http://planetrubyonrails.com/325HOME |
Hi,
I have been using jsdoc-toolkit (http://code.google.com/p/jsdoc-toolkit/w/list) to document my javascript. I am wanting to show inherited props/methods from Ext objects that I extend. This works for standard objects but not those that Ext.extend(... or the module pattern. To fix, I added the @scope like so:
Ext.Container = Ext.extend(Ext.BoxComponent, /** @scope Ext.Container.prototype */{
or
function MyObj() {
var foo = "boo";
return /** @scope MyObj.prototype */ {
getFoo: function() ...
}
}
Is this something that could be worked into the main Ext src documentation? If so, and with a few minor changes, Ext could use JsDoc for it's documentation as well as those of us who want to show Ext base classes.
Even more, a template could be created that provides the look and feel of the Ext 2 doc system.
extjs.com/forum/showthread.php?p=84478::
href=http://av.rds.yahoo.com/_ylt=A0oGktqavWVJGwEA7GBtCqMX;_ylu=X3oDMTBzdXAxcThoBHBndANhdl93ZWJfYWR2X3Jlc3VsdARzZWMDc3I-/SIG=123174cqs/EXP=1231490842/**http%3A//extjs.com/forum/showthread.php%3Fp=84478>extjs.com/forum/showthread.php?p=84478extjs.com/forum/showthread.php?p=84478 More pages from extjs.com
Result Pages:
<< Prev 1
Back To Top
Advanced Web Search
Help
Build a query with
all of these words:
this exact phrase:
any of these words:
and none of these words
SEARCH:
Worldwide
USA
RESULTS IN:
All languages
English, Spanish
Date:
by timeframe:
Anytime
Week
Two weeks
Month
Four months
Eight months
One year
by date range:
12345678910111213141516171819202122232425262728293031
JanuaryFebruaryMarchAprilMayJuneJulyAugustSeptemberOctoberNovemberDecember
198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009
12345678910111213141516171819202122232425262728293031
JanuaryFebruaryMarchAprilMayJuneJulyAugustSeptemberOctoberNovemberDecember
198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009
File type:
Any format
Adobe PDF (.pdf)
Microsoft Word (.doc)
Microsoft Excel (.xls)
Microsoft Power Point (.ppt)
HTML
Text (.txt)
Location
by domain:
By URL:
Display:
site collapse (on/off) What is this?
10
20
30
40
50
results per page
Another great way to search. Try Yahoo! Answers
Business Services
Submit a Site
About AltaVista
Privacy Policy
Help
© 2007 Overture Services, Inc.
http://ef=av.rds.yahoo.com/_ylt=A0oGktqavWVJGwEA7GBtCqMX;_ylu=X3oDMTBzdXAxcThoBHBndANhdl93ZWJfYWR2X3Jlc3VsdARzZWMDc3I-/SIG=123174cqs/EXP=1231490842/**extjs.com/forum/showthread.php?p=84478>extjs.com/forum/showthread.php?p=84478
extjs.com/forum/showthread.php?p=84478HOME |
What do you think?
OK. I grabbed the release candidate. (usually work off of the latest from SVN).
However, they seem to be broken. I get the following error/output in firebug:
GET file:///path/to/ext-2.0-rc1/docs/welcome.html?_dc=1194694122878 (30ms)ext-base.js (line 10)
this.el has no properties
[Break on this error] Ext.Component=function(B){B=B{};if(B.initialConf ig){if(B.isAction){this.baseAc...
Oh wait... I see you have to have them running in a web context to work... Seems kind of silly for API documentation.
JsDoc uses extends as well, but it needs the @scope and the object's prototype so it knows to add to the object's prototype for documentation puposes. It is a nice, simple documentation element that enables jsdoc to document a variety of coding styles.
Basically, you have all you need in jsdoc for the existing commented Ext code. Why not just use it? Then people can generate there owns docs for Ext and link to them from there own code. It is a pain to rely on an online version of the documentation, especially when on a plane or travelling or just generally working offline...
Thanks for pointing out that the docs are in the downloadable version. I am travelling next week and I am glad I can access the api when offline. I am perfectly fine running them from a web context. It does seem silly to me that Ext api docs only run from a web context. Why something that should be considered critical is made in such a fluffy way is beyond me, but whatev...
York Haskell Compiler::
The Haskell Web Toolkit library is not large at the moment, but it will 30 enhancement requests - often relating to cleaning up the internals of Yhc.
http://yhc06.blogspot.comHOME |
trac.dojotoolkit.org/report/40?format=csv&USER=anonymous::
button enhancements,Dojox,1.1,enhancement,2006-10-11T08:06:11Z an enhancement. FF DEBUG: failed loading ../src/docs.js with error: [SyntaxError:
http://trac.dojotoolkit.org/report/40?format=csv&USER=anonymousHOME |
Well, developing while offline (on an app that most likely can't run offline) isn't a likely scenario. Anyway, however likely or unlikely that is, the changes are small to make it so the docs run offline as well. They're not going to be like docs you find because the Ext docs attempt to "eat their own dogfood" (quite well, I might add). As this means using XHR, that means they run only in a web context unless you enhance them as discussed in these forums.
If you look at Ext's documentation you will notice that we use:
@extends Ext.Container
I don't know that there are any plans to release our documentation tool yet. But if you have the flexibility to make-up a scheme for documentation I would just suggest minimicing Ext's simply for compatability.
Look... I have been getting Ext from SVN. That has no docs other than the code - why? I have wondered.
Thanks for pointing out that the docs are in the downloadable version. I am travelling next week and I am glad I can access the api when offline. I am perfectly fine running them from a web context. It does seem silly to me that Ext api docs only run from a web context. Why something that should be considered critical is made in such a fluffy way is beyond me, but whatev...
Getting back to the original intention of this thread: I proposed the @scope change to allow users to be able to better document their code. It is basically a freebie for the Ext foundation (or whatever it is). Sure, I can add @scope where I need it and merge the latest from SVN.
It would be nice if there was a standard documentation style for all javascript. JsDoc seems to cover all needs. And the results can look like whatever you want with their template system. Ext's documentation system is not visibile.
Again, whatev...
You don't have to rely on the docs online as a copy of them is included with the downloadable zip.
There was a thread just a few days ago about the limited changes necessary to make them work completely offline as well.
If you consider that 99.9% of web development is for an online context, it really isn't that silly that docs work in a web context as well. At the very least you could install Apache or something and run them on a local webserver (if you don't want to apply the changes available in the thread I mentioned).
 I Am a Sinner – What About You?
 Global Sourcing and Supplier Online by Dylan
|
Docs enhancement: @scope jsdoc-toolkit