1. #1
    Sencha User
    Join Date
    Mar 2007
    Location
    Montana
    Posts
    51
    Vote Rating
    0
    jamaljohnson is on a distinguished road

      0  

    Default JSDoc template files

    JSDoc template files


    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!

  2. #2
    Sencha User jack.slocum's Avatar
    Join Date
    Mar 2007
    Location
    Tampa, FL
    Posts
    6,955
    Vote Rating
    17
    jack.slocum will become famous soon enough jack.slocum will become famous soon enough

      0  

    Default


    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

  3. #3
    Sencha User
    Join Date
    Mar 2007
    Location
    Montana
    Posts
    51
    Vote Rating
    0
    jamaljohnson is on a distinguished road

      0  

    Default perfect

    perfect


    awesome, thanx jack

  4. #4
    Sencha User
    Join Date
    Mar 2007
    Location
    Montana
    Posts
    51
    Vote Rating
    0
    jamaljohnson is on a distinguished road

      0  

    Default


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

  5. #5
    Sencha User
    Join Date
    Apr 2012
    Location
    Austin, Texas
    Posts
    4
    Vote Rating
    0
    brian.moeskau is an unknown quantity at this point

      0  

    Default


    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.

  6. #6
    Ext User
    Join Date
    Mar 2007
    Posts
    1
    Vote Rating
    0
    coolhand27 is on a distinguished road

      0  

    Default


    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

  7. #7
    Sencha User
    Join Date
    Apr 2012
    Location
    Austin, Texas
    Posts
    4
    Vote Rating
    0
    brian.moeskau is an unknown quantity at this point

      0  

    Default


    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.

  8. #8
    Ext User
    Join Date
    Mar 2007
    Posts
    153
    Vote Rating
    1
    JohnT is on a distinguished road

      0  

    Default


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

  9. #9
    Sencha User
    Join Date
    Mar 2007
    Posts
    7,854
    Vote Rating
    4
    tryanDLS is on a distinguished road

      0  

    Default


    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.

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

  10. #10
    Ext User
    Join Date
    Mar 2007
    Posts
    52
    Vote Rating
    2
    exo is on a distinguished road

      0  

    Default


    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?

Similar Threads

  1. Ext.DomHelper.Template: one template, ten YUI grids
    By moraes in forum Community Discussion
    Replies: 11
    Last Post: 18 Dec 2012, 4:55 AM
  2. JSDoc - how to generate dynamic documentation out of code
    By humpdi in forum Community Discussion
    Replies: 3
    Last Post: 14 Mar 2007, 1:23 AM
  3. Ext.DomHelper.Template or Ext.Template?
    By mystix in forum Ext 2.x: Help & Discussion
    Replies: 4
    Last Post: 1 Mar 2007, 3:05 PM
  4. JSDoc
    By sleepyhead in forum Sencha Cmd
    Replies: 5
    Last Post: 22 Jan 2007, 10:22 PM
  5. JSDoc-2
    By Choleriker in forum Community Discussion
    Replies: 4
    Last Post: 13 Dec 2006, 6:51 AM

Thread Participants: 9