JSDoc template files

[jamaljohnson]

jack, i searched around on the forum a bit and didn't find anything, but do you have your documentation tmpl files available? i'm a fan of your look and feel. thanx!

[jack.slocum]

Sure. They aren't great though. I just zipped my jsdoc directory and threw it up here for you:

http://www.jackslocum.com/blog/jsdoc-dist.zip

[jamaljohnson]

awesome, thanx jack

[jamaljohnson]

ok, now that you have _really_ sick documentation, any chance of getting that distribution?

[brian.moeskau]

FYI, Jack's out this week, so you may want to bump this post again next week if you haven't heard from him by then.

[coolhand27]

Looks like the link to the JSDoc tmpl link is dead. Any chance you can update it? I like to take a look at how you are doing your documentation so that I can implement something similar.

Thx

[brian.moeskau]

I believe it was just a zipped version of the released docs: http://www.yui-ext.com/deploy/yui-ext/docs/

Jack has not yet released any of his newest doc parser source code or templates other than the deployed doc output.

[JohnT]

Ok I am glad someone bumped this.

I have a question regarding documenting your code. I know there is no right and wrong way, but let's say I had the following function in an object, should I document this, or only real classes?

Example:

				addAmmo : function(amt){
					for(var i=0; i<amt; i++){
						oConfig = {
							tag : "img",
							src : "images/shell.gif"
						};
						getEl("bulletHolder").createChild(oConfig);
					}
					oGun.bulletsLeft += amt;
				}

[tryanDLS]

I would document all the methods - not worth trying to decide for each fn whether it's worthy of doc - if it was important enough to make a fn, it should be doc'd.

/**
 * Add a specified amount of ammo to the display and the gun.
 * @private or @public
 * @pararm {integer} amt The amount of ammo to add
 */

[exo]

I would really really like to be able to generate the same kind of documentation as Ext uses. What sort of stuff will I need for that? JSdoc, templates?