jsdoc-user — Anything about JSDoc, including questions, bugs, requests for new features, ...

Re: [Jsdoc-user] Hosting platform

[Cameron S. <cam...@gm...>]

Sourceforge offers subversion now.

I moved my project away from Sourceforge a while back. They didn't 
support Subversion at the time, their issue tracking poor, and they 
didn't have a decent wiki. The issue tracker has no concept of releases, 
so you can't fix a bug in one release, but keep it open in another. (At 
least that was the case 1 year ago).

I suggest you try and find a host that provides:
* Subversion
* Bug tracking: trac or JIRA, (there are a few others that might be ok)
* A wiki: Mediawiki seems to be one of the better ones.



Michael Mathews wrote:
> Great, thanks for the commitment, Paul. We can use any help we can get! 
> What's your ID on SourceForge.net, I'll add you as a developer on the 
> project (even if you just do testing).
> 
> I'm considering hosting the JSDoc 2 project on google actually. Any one 
> have a preference? One difference I've found is that google uses svn and 
> is somewhat faster, but sourceforge is more featureful.
> 
> Vote now...
> 
> On 18/10/06, *Paul Spencer* <psp...@dm... 
> <mailto:psp...@dm...>> wrote:
> 
>     I would love to be part of your testing team.  I can provide some
>     samples of Prototype code that should test the system, and can run
>     tests against some fairly large projects - um, now I'll have to
>     actually write the documentation!
> 
>     Cheers
> 
>     Paul
> 
>     On 18-Oct-06, at 9:06 AM, Michael Mathews wrote:
> 
>      > Hi Paul,
>      >
>      > I think it's pretty safe to say JSDoc 2 will support Prototype. The
>      > only question is how to best implement that support. You can help:
>      > send me a typical file of Prototype JS you've written and can't get
>      > JSDoc 1 to work with. I'll make that part of a unit test and start
>      > planning how to support that syntax. (I've never actually used
>      > Prototype myself)
>      >
>      > It may be as simple as writing some detailed documentation on how
>      > to get the current tool to work with Prototype's syntax, but if, as
>      > I suspect, the JSDoc tool itself needs to be modified, we'll make
>      > that a priority.
>      >
>      > Also would you volunteer to run tests on any new release candidates
>      > to confirm that they work against your Prototype code?
>      >
>      > regards,
>      > Michael < mi...@gm... <mailto:mi...@gm...>>
>      >
>      > On 18/10/06, Paul Spencer <psp...@dm...
>     <mailto:psp...@dm...>> wrote: Gabriel,
>      >
>      > for me, the most pressing need is for something that can work with
>      > Prototype.js (http://prototype.conio.net) style coding.  I think
>      > jsdoc already has excellent features for its output, but it is
>      > essentially unusable for me as I am using Prototype as my base
>      > library.  It would also be awesome just for documenting Prototype :)
>      >
>      > Cheers
>      >
>      > Paul
>      >
>      > On 16-Oct-06, at 11:30 AM, Gabriel Reid wrote:
>      >
>      > > Hi Everyone,
>      > >
>      > > I'm just passing on this announcement from Michael Mathews about a
>      > > second
>      > > incarnation of JSDoc that is currently in the planning phase. We're
>      > > hoping
>      > > to address the many shortcomings of the current version of JSDoc,
>      > > but we
>      > > first need to get feedback from everyone who is using the tool.
>      > >
>      > > If you have any JavaScript documenting wants or needs that JSDoc
>      > isn't
>      > > currently addressing, now is your chance to let yourself be heard!
>      > >
>      > > The discussion can be found at <http://groups.google.com/group/
>      > > jsdoc-2>.
>      > >
>      > > Looking forward to hearing from you!
>      > >
>      > >
>      > > Regards,
>      > >
>      > >     Gabriel Reid
>      > >
>      > >
>      > > ----- Forwarded message  -----
>      > >
>      > > ANNOUNCEMENT: For quite a long time now Gabriel Reid has been
>      > laboring
>      > > valiently to keep up with the evolving needs and requests of the
>      > JSDoc
>      > > users, burdened by a general design which simply wasn't flexible
>      > > enough
>      > > to easily handle the new world of JavaScript we now find
>      > ourselves in.
>      > >
>      > > I take full responsibility for getting Gabriel into this
>      > situation and
>      > > want to make what ammends I can by helping to design a new, more
>      > > powerful, flexible and extensable version for the future. JSDoc 2.0
>      > > will be a ground-up rebuild with the paramount intention of
>     handling
>      > > more variations in code and style than was possible in JSDoc 1.
>      > >
>      > > So, while the clay is still wet and gooey, you are highly
>      > > encouraged to
>      > > stick a finger into the shape of what JSDoc 2 will be. What
>     have you
>      > > always wanted but couldn't have in your JS documentation? Any and
>      > all
>      > > suggestions will be considered and, if the case is good, will be
>      > > implemented.
>      > >
>      > >
>      > > ----- End forwarded message -----
>      > >
>      > >
>      >
>     ----------------------------------------------------------------------
>      > > ---
>      > > Using Tomcat but need to do more? Need to support web services,
>      > > security?
>      > > Get stuff done quickly with pre-integrated technology to make your
>      > > job easier
>      > > Download IBM WebSphere Application Server v.1.0.1 based on Apache
>      > > Geronimo
>      > > http://sel.as-us.falkag.net/sel?
>      > > cmd=lnk&kid=120709&bid=263057&dat=121642
>      > > _______________________________________________
>      > > Jsdoc-user mailing list
>      > > Jsd...@li...
>     <mailto:Jsd...@li...>
>      > > https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>     <https://lists.sourceforge.net/lists/listinfo/jsdoc-user>
>      >
>      > +-----------------------------------------------------------------+
>      > |Paul Spencer                          psp...@dm...
>     <mailto:psp...@dm...>     |
>      > +-----------------------------------------------------------------+
>      > |Chief Technology Officer                                         |
>      > |DM Solutions Group Inc                 http://www.dmsolutions.ca/ |
>      > +-----------------------------------------------------------------+
>      >
>      >
>      >
>      >
>      >
>      >
>     ----------------------------------------------------------------------
>      > ---
>      > Using Tomcat but need to do more? Need to support web services,
>      > security?
>      > Get stuff done quickly with pre-integrated technology to make your
>      > job easier
>      > Download IBM WebSphere Application Server v.1.0.1 based on Apache
>      > Geronimo
>      > http://sel.as-us.falkag.net/sel?
>      > cmd=lnk&kid=120709&bid=263057&dat=121642
>      > _______________________________________________
>      > Jsdoc-user mailing list
>      > Jsd...@li...
>     <mailto:Jsd...@li...>
>      > https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>      >
> 
>     +-----------------------------------------------------------------+
>     |Paul Spencer                          psp...@dm...
>     <mailto:psp...@dm...>    |
>     +-----------------------------------------------------------------+
>     |Chief Technology Officer                                         |
>     |DM Solutions Group Inc                http://www.dmsolutions.ca/ |
>     +-----------------------------------------------------------------+
> 
> 
> 
> 
> 
> 
> ------------------------------------------------------------------------
> 
> -------------------------------------------------------------------------
> Using Tomcat but need to do more? Need to support web services, security?
> Get stuff done quickly with pre-integrated technology to make your job easier
> Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
> 
> 
> ------------------------------------------------------------------------
> 
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user


-- 
Cameron Shorter
http://cameron.shorter.net

Re: [Jsdoc-user] [JSDoc 2 is now in the Initial Planning Phase -- Have at it!]

[Paul S. <psp...@dm...>]

I believe I am 'pagameba' on sourceforge.  I have no experience with  
Google so I can't comment on that.

Cheers

Paul

On 18-Oct-06, at 12:24 PM, Michael Mathews wrote:

> Great, thanks for the commitment, Paul. We can use any help we can  
> get! What's your ID on SourceForge.net, I'll add you as a developer  
> on the project (even if you just do testing).
>
> I'm considering hosting the JSDoc 2 project on google actually. Any  
> one have a preference? One difference I've found is that google  
> uses svn and is somewhat faster, but sourceforge is more featureful.
>
> Vote now...
>
> On 18/10/06, Paul Spencer <psp...@dm...> wrote: I would  
> love to be part of your testing team.  I can provide some
> samples of Prototype code that should test the system, and can run
> tests against some fairly large projects - um, now I'll have to
> actually write the documentation!
>
> Cheers
>
> Paul
>
> On 18-Oct-06, at 9:06 AM, Michael Mathews wrote:
>
> > Hi Paul,
> >
> > I think it's pretty safe to say JSDoc 2 will support Prototype. The
> > only question is how to best implement that support. You can help:
> > send me a typical file of Prototype JS you've written and can't get
> > JSDoc 1 to work with. I'll make that part of a unit test and start
> > planning how to support that syntax. (I've never actually used
> > Prototype myself)
> >
> > It may be as simple as writing some detailed documentation on how
> > to get the current tool to work with Prototype's syntax, but if, as
> > I suspect, the JSDoc tool itself needs to be modified, we'll make
> > that a priority.
> >
> > Also would you volunteer to run tests on any new release candidates
> > to confirm that they work against your Prototype code?
> >
> > regards,
> > Michael < mi...@gm...>
> >
> > On 18/10/06, Paul Spencer <psp...@dm...> wrote: Gabriel,
> >
> > for me, the most pressing need is for something that can work with
> > Prototype.js (http://prototype.conio.net) style coding.  I think
> > jsdoc already has excellent features for its output, but it is
> > essentially unusable for me as I am using Prototype as my base
> > library.  It would also be awesome just for documenting Prototype :)
> >
> > Cheers
> >
> > Paul
> >
> > On 16-Oct-06, at 11:30 AM, Gabriel Reid wrote:
> >
> > > Hi Everyone,
> > >
> > > I'm just passing on this announcement from Michael Mathews about a
> > > second
> > > incarnation of JSDoc that is currently in the planning phase.  
> We're
> > > hoping
> > > to address the many shortcomings of the current version of JSDoc,
> > > but we
> > > first need to get feedback from everyone who is using the tool.
> > >
> > > If you have any JavaScript documenting wants or needs that JSDoc
> > isn't
> > > currently addressing, now is your chance to let yourself be heard!
> > >
> > > The discussion can be found at <http://groups.google.com/group/
> > > jsdoc-2>.
> > >
> > > Looking forward to hearing from you!
> > >
> > >
> > > Regards,
> > >
> > >     Gabriel Reid
> > >
> > >
> > > ----- Forwarded message  -----
> > >
> > > ANNOUNCEMENT: For quite a long time now Gabriel Reid has been
> > laboring
> > > valiently to keep up with the evolving needs and requests of the
> > JSDoc
> > > users, burdened by a general design which simply wasn't flexible
> > > enough
> > > to easily handle the new world of JavaScript we now find
> > ourselves in.
> > >
> > > I take full responsibility for getting Gabriel into this
> > situation and
> > > want to make what ammends I can by helping to design a new, more
> > > powerful, flexible and extensable version for the future. JSDoc  
> 2.0
> > > will be a ground-up rebuild with the paramount intention of  
> handling
> > > more variations in code and style than was possible in JSDoc 1.
> > >
> > > So, while the clay is still wet and gooey, you are highly
> > > encouraged to
> > > stick a finger into the shape of what JSDoc 2 will be. What  
> have you
> > > always wanted but couldn't have in your JS documentation? Any and
> > all
> > > suggestions will be considered and, if the case is good, will be
> > > implemented.
> > >
> > >
> > > ----- End forwarded message -----
> > >
> > >
> >  
> ----------------------------------------------------------------------
> > > ---
> > > Using Tomcat but need to do more? Need to support web services,
> > > security?
> > > Get stuff done quickly with pre-integrated technology to make your
> > > job easier
> > > Download IBM WebSphere Application Server v.1.0.1 based on Apache
> > > Geronimo
> > > http://sel.as-us.falkag.net/sel?
> > > cmd=lnk&kid=120709&bid=263057&dat=121642
> > > _______________________________________________
> > > Jsdoc-user mailing list
> > > Jsd...@li...
> > > https://lists.sourceforge.net/lists/listinfo/jsdoc-user
> >
> > +-----------------------------------------------------------------+
> > |Paul Spencer                          psp...@dm...     |
> > +-----------------------------------------------------------------+
> > |Chief Technology Officer                                         |
> > |DM Solutions Group Inc                 http://www.dmsolutions.ca/ |
> > +-----------------------------------------------------------------+
> >
> >
> >
> >
> >
> >  
> ----------------------------------------------------------------------
> > ---
> > Using Tomcat but need to do more? Need to support web services,
> > security?
> > Get stuff done quickly with pre-integrated technology to make your
> > job easier
> > Download IBM WebSphere Application Server v.1.0.1 based on Apache
> > Geronimo
> > http://sel.as-us.falkag.net/sel?
> > cmd=lnk&kid=120709&bid=263057&dat=121642
> > _______________________________________________
> > Jsdoc-user mailing list
> > Jsd...@li...
> > https://lists.sourceforge.net/lists/listinfo/jsdoc-user
> >
>
> +-----------------------------------------------------------------+
> |Paul Spencer                          psp...@dm...    |
> +-----------------------------------------------------------------+
> |Chief Technology Officer                                         |
> |DM Solutions Group Inc                http://www.dmsolutions.ca/ |
> +-----------------------------------------------------------------+
>
>
>
>
>

+-----------------------------------------------------------------+
|Paul Spencer                          psp...@dm...    |
+-----------------------------------------------------------------+
|Chief Technology Officer                                         |
|DM Solutions Group Inc                http://www.dmsolutions.ca/ |
+-----------------------------------------------------------------+

Re: [Jsdoc-user] [JSDoc 2 is now in the Initial Planning Phase -- Haveat it!]

[Michael M. <mi...@gm...>]

http://code.google.com/hosting/

On 18/10/06, Michael Mathews <mi...@gm...> wrote:
>
> <Michael pulls on flame-proof pajamas>
>
> Please note that supporting Prototype, or any framework, is not an
> endorsement of any particular practice those frameworks may or may not
> engage in (especially the well-beaten topic of modifying the
> Object.prototype field.)
>
> As I've said elsewhere, I myself don't use Prototype -- tried it once and
> didn't keep it --  but I have participated in the blog-o-bating about it
> elsewhere. If anyone wants to join that debate THIS IS NOT THE PLACE. Oops,
> my all-caps must have locked on there. Sorry bout that.
>
> But thanks for the  input :-)
>
> Regards,
> Michael
>
> On 18/10/06, Peter Michaux <pet...@gm... > wrote:
> >
> > > And yes, your claim is backed up by the recent survey at Ajaxian:
> > >
> > > http://ajaxian.com/archives/ajaxiancom-2006-survey-results
> >
> > Given all Prototype's shortcomings and bad practices this is
> > unfortunate. JS developers should strive for better.
> >
> > Peter
> >
>
>

Re: [Jsdoc-user] [JSDoc 2 is now in the Initial Planning Phase -- Have at it!]

[Michael M. <mi...@gm...>]

Great, thanks for the commitment, Paul. We can use any help we can get!
What's your ID on SourceForge.net, I'll add you as a developer on the
project (even if you just do testing).

I'm considering hosting the JSDoc 2 project on google actually. Any one have
a preference? One difference I've found is that google uses svn and is
somewhat faster, but sourceforge is more featureful.

Vote now...

On 18/10/06, Paul Spencer <psp...@dm...> wrote:
>
> I would love to be part of your testing team.  I can provide some
> samples of Prototype code that should test the system, and can run
> tests against some fairly large projects - um, now I'll have to
> actually write the documentation!
>
> Cheers
>
> Paul
>
> On 18-Oct-06, at 9:06 AM, Michael Mathews wrote:
>
> > Hi Paul,
> >
> > I think it's pretty safe to say JSDoc 2 will support Prototype. The
> > only question is how to best implement that support. You can help:
> > send me a typical file of Prototype JS you've written and can't get
> > JSDoc 1 to work with. I'll make that part of a unit test and start
> > planning how to support that syntax. (I've never actually used
> > Prototype myself)
> >
> > It may be as simple as writing some detailed documentation on how
> > to get the current tool to work with Prototype's syntax, but if, as
> > I suspect, the JSDoc tool itself needs to be modified, we'll make
> > that a priority.
> >
> > Also would you volunteer to run tests on any new release candidates
> > to confirm that they work against your Prototype code?
> >
> > regards,
> > Michael <mi...@gm...>
> >
> > On 18/10/06, Paul Spencer <psp...@dm...> wrote: Gabriel,
> >
> > for me, the most pressing need is for something that can work with
> > Prototype.js (http://prototype.conio.net) style coding.  I think
> > jsdoc already has excellent features for its output, but it is
> > essentially unusable for me as I am using Prototype as my base
> > library.  It would also be awesome just for documenting Prototype :)
> >
> > Cheers
> >
> > Paul
> >
> > On 16-Oct-06, at 11:30 AM, Gabriel Reid wrote:
> >
> > > Hi Everyone,
> > >
> > > I'm just passing on this announcement from Michael Mathews about a
> > > second
> > > incarnation of JSDoc that is currently in the planning phase. We're
> > > hoping
> > > to address the many shortcomings of the current version of JSDoc,
> > > but we
> > > first need to get feedback from everyone who is using the tool.
> > >
> > > If you have any JavaScript documenting wants or needs that JSDoc
> > isn't
> > > currently addressing, now is your chance to let yourself be heard!
> > >
> > > The discussion can be found at <http://groups.google.com/group/
> > > jsdoc-2>.
> > >
> > > Looking forward to hearing from you!
> > >
> > >
> > > Regards,
> > >
> > >     Gabriel Reid
> > >
> > >
> > > ----- Forwarded message  -----
> > >
> > > ANNOUNCEMENT: For quite a long time now Gabriel Reid has been
> > laboring
> > > valiently to keep up with the evolving needs and requests of the
> > JSDoc
> > > users, burdened by a general design which simply wasn't flexible
> > > enough
> > > to easily handle the new world of JavaScript we now find
> > ourselves in.
> > >
> > > I take full responsibility for getting Gabriel into this
> > situation and
> > > want to make what ammends I can by helping to design a new, more
> > > powerful, flexible and extensable version for the future. JSDoc 2.0
> > > will be a ground-up rebuild with the paramount intention of handling
> > > more variations in code and style than was possible in JSDoc 1.
> > >
> > > So, while the clay is still wet and gooey, you are highly
> > > encouraged to
> > > stick a finger into the shape of what JSDoc 2 will be. What have you
> > > always wanted but couldn't have in your JS documentation? Any and
> > all
> > > suggestions will be considered and, if the case is good, will be
> > > implemented.
> > >
> > >
> > > ----- End forwarded message -----
> > >
> > >
> > ----------------------------------------------------------------------
> > > ---
> > > Using Tomcat but need to do more? Need to support web services,
> > > security?
> > > Get stuff done quickly with pre-integrated technology to make your
> > > job easier
> > > Download IBM WebSphere Application Server v.1.0.1 based on Apache
> > > Geronimo
> > > http://sel.as-us.falkag.net/sel?
> > > cmd=lnk&kid=120709&bid=263057&dat=121642
> > > _______________________________________________
> > > Jsdoc-user mailing list
> > > Jsd...@li...
> > > https://lists.sourceforge.net/lists/listinfo/jsdoc-user
> >
> > +-----------------------------------------------------------------+
> > |Paul Spencer                          psp...@dm...     |
> > +-----------------------------------------------------------------+
> > |Chief Technology Officer                                         |
> > |DM Solutions Group Inc                 http://www.dmsolutions.ca/ |
> > +-----------------------------------------------------------------+
> >
> >
> >
> >
> >
> > ----------------------------------------------------------------------
> > ---
> > Using Tomcat but need to do more? Need to support web services,
> > security?
> > Get stuff done quickly with pre-integrated technology to make your
> > job easier
> > Download IBM WebSphere Application Server v.1.0.1 based on Apache
> > Geronimo
> > http://sel.as-us.falkag.net/sel?
> > cmd=lnk&kid=120709&bid=263057&dat=121642
> > _______________________________________________
> > Jsdoc-user mailing list
> > Jsd...@li...
> > https://lists.sourceforge.net/lists/listinfo/jsdoc-user
> >
>
> +-----------------------------------------------------------------+
> |Paul Spencer                          psp...@dm...    |
> +-----------------------------------------------------------------+
> |Chief Technology Officer                                         |
> |DM Solutions Group Inc                http://www.dmsolutions.ca/ |
> +-----------------------------------------------------------------+
>
>
>
>
>

Re: [Jsdoc-user] [JSDoc 2 is now in the Initial Planning Phase -- Have at it!]

[Paul S. <psp...@dm...>]

I would love to be part of your testing team.  I can provide some  
samples of Prototype code that should test the system, and can run  
tests against some fairly large projects - um, now I'll have to  
actually write the documentation!

Cheers

Paul

On 18-Oct-06, at 9:06 AM, Michael Mathews wrote:

> Hi Paul,
>
> I think it's pretty safe to say JSDoc 2 will support Prototype. The  
> only question is how to best implement that support. You can help:  
> send me a typical file of Prototype JS you've written and can't get  
> JSDoc 1 to work with. I'll make that part of a unit test and start  
> planning how to support that syntax. (I've never actually used  
> Prototype myself)
>
> It may be as simple as writing some detailed documentation on how  
> to get the current tool to work with Prototype's syntax, but if, as  
> I suspect, the JSDoc tool itself needs to be modified, we'll make  
> that a priority.
>
> Also would you volunteer to run tests on any new release candidates  
> to confirm that they work against your Prototype code?
>
> regards,
> Michael <mi...@gm...>
>
> On 18/10/06, Paul Spencer <psp...@dm...> wrote: Gabriel,
>
> for me, the most pressing need is for something that can work with
> Prototype.js (http://prototype.conio.net) style coding.  I think
> jsdoc already has excellent features for its output, but it is
> essentially unusable for me as I am using Prototype as my base
> library.  It would also be awesome just for documenting Prototype :)
>
> Cheers
>
> Paul
>
> On 16-Oct-06, at 11:30 AM, Gabriel Reid wrote:
>
> > Hi Everyone,
> >
> > I'm just passing on this announcement from Michael Mathews about a
> > second
> > incarnation of JSDoc that is currently in the planning phase. We're
> > hoping
> > to address the many shortcomings of the current version of JSDoc,
> > but we
> > first need to get feedback from everyone who is using the tool.
> >
> > If you have any JavaScript documenting wants or needs that JSDoc  
> isn't
> > currently addressing, now is your chance to let yourself be heard!
> >
> > The discussion can be found at <http://groups.google.com/group/
> > jsdoc-2>.
> >
> > Looking forward to hearing from you!
> >
> >
> > Regards,
> >
> >     Gabriel Reid
> >
> >
> > ----- Forwarded message  -----
> >
> > ANNOUNCEMENT: For quite a long time now Gabriel Reid has been  
> laboring
> > valiently to keep up with the evolving needs and requests of the  
> JSDoc
> > users, burdened by a general design which simply wasn't flexible
> > enough
> > to easily handle the new world of JavaScript we now find  
> ourselves in.
> >
> > I take full responsibility for getting Gabriel into this  
> situation and
> > want to make what ammends I can by helping to design a new, more
> > powerful, flexible and extensable version for the future. JSDoc 2.0
> > will be a ground-up rebuild with the paramount intention of handling
> > more variations in code and style than was possible in JSDoc 1.
> >
> > So, while the clay is still wet and gooey, you are highly
> > encouraged to
> > stick a finger into the shape of what JSDoc 2 will be. What have you
> > always wanted but couldn't have in your JS documentation? Any and  
> all
> > suggestions will be considered and, if the case is good, will be
> > implemented.
> >
> >
> > ----- End forwarded message -----
> >
> >  
> ----------------------------------------------------------------------
> > ---
> > Using Tomcat but need to do more? Need to support web services,
> > security?
> > Get stuff done quickly with pre-integrated technology to make your
> > job easier
> > Download IBM WebSphere Application Server v.1.0.1 based on Apache
> > Geronimo
> > http://sel.as-us.falkag.net/sel?
> > cmd=lnk&kid=120709&bid=263057&dat=121642
> > _______________________________________________
> > Jsdoc-user mailing list
> > Jsd...@li...
> > https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>
> +-----------------------------------------------------------------+
> |Paul Spencer                          psp...@dm...     |
> +-----------------------------------------------------------------+
> |Chief Technology Officer                                         |
> |DM Solutions Group Inc                 http://www.dmsolutions.ca/ |
> +-----------------------------------------------------------------+
>
>
>
>
>
> ---------------------------------------------------------------------- 
> ---
> Using Tomcat but need to do more? Need to support web services,  
> security?
> Get stuff done quickly with pre-integrated technology to make your  
> job easier
> Download IBM WebSphere Application Server v.1.0.1 based on Apache  
> Geronimo
> http://sel.as-us.falkag.net/sel? 
> cmd=lnk&kid=120709&bid=263057&dat=121642
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>

+-----------------------------------------------------------------+
|Paul Spencer                          psp...@dm...    |
+-----------------------------------------------------------------+
|Chief Technology Officer                                         |
|DM Solutions Group Inc                http://www.dmsolutions.ca/ |
+-----------------------------------------------------------------+

Re: [Jsdoc-user] [JSDoc 2 is now in the Initial Planning Phase -- Haveat it!]

[Michael M. <mi...@gm...>]

We hear you Marc!

And yes, your claim is backed up by the recent survey at Ajaxian:
   http://ajaxian.com/archives/ajaxiancom-2006-survey-results

Prototype is indeed popular. Ideally we can find a way to support any
framework, but certainly Prototype seems to be a must-have.

Thanks for your input Marc!

Regards

On 18/10/06, Marc Roger Bria Ramirez <mar...@ua...> wrote:
>
> Paul Spencer wrote:
> > Gabriel,
> >
> > for me, the most pressing need is for something that can work with
> > Prototype.js (http://prototype.conio.net) style coding.  I think
> > jsdoc already has excellent features for its output, but it is
> > essentially unusable for me as I am using Prototype as my base
> > library.  It would also be awesome just for documenting Prototype :)
> >
> > Cheers
> >
>
> +100 to Paul's suggestion. :-)
>
> JSdoc is wonderful, but when I finish my developments I need to reedit
> my code in a way JSDoc could document it.
>
> I think prototype library is becoming a "facto" standard for JS
> developers.
> > Paul
> >
> > On 16-Oct-06, at 11:30 AM, Gabriel Reid wrote:
> >
> >
> >> Hi Everyone,
> >>
> >> I'm just passing on this announcement from Michael Mathews about a
> >> second
> >> incarnation of JSDoc that is currently in the planning phase. We're
> >> hoping
> >> to address the many shortcomings of the current version of JSDoc,
> >> but we
> >> first need to get feedback from everyone who is using the tool.
> >>
> >> If you have any JavaScript documenting wants or needs that JSDoc isn't
> >> currently addressing, now is your chance to let yourself be heard!
> >>
> >> The discussion can be found at <http://groups.google.com/group/
> >> jsdoc-2>.
> >>
> >> Looking forward to hearing from you!
> >>
> >>
> >> Regards,
> >>
> >>     Gabriel Reid
> >>
> >>
> >> ----- Forwarded message  -----
> >>
> >> ANNOUNCEMENT: For quite a long time now Gabriel Reid has been laboring
> >> valiently to keep up with the evolving needs and requests of the JSDoc
> >> users, burdened by a general design which simply wasn't flexible
> >> enough
> >> to easily handle the new world of JavaScript we now find ourselves in.
> >>
> >> I take full responsibility for getting Gabriel into this situation and
> >> want to make what ammends I can by helping to design a new, more
> >> powerful, flexible and extensable version for the future. JSDoc 2.0
> >> will be a ground-up rebuild with the paramount intention of handling
> >> more variations in code and style than was possible in JSDoc 1.
> >>
> >> So, while the clay is still wet and gooey, you are highly
> >> encouraged to
> >> stick a finger into the shape of what JSDoc 2 will be. What have you
> >> always wanted but couldn't have in your JS documentation? Any and all
> >> suggestions will be considered and, if the case is good, will be
> >> implemented.
> >>
> >>
> >> ----- End forwarded message -----
> >>
> >> ----------------------------------------------------------------------
> >> ---
> >> Using Tomcat but need to do more? Need to support web services,
> >> security?
> >> Get stuff done quickly with pre-integrated technology to make your
> >> job easier
> >> Download IBM WebSphere Application Server v.1.0.1 based on Apache
> >> Geronimo
> >> http://sel.as-us.falkag.net/sel?
> >> cmd=lnk&kid=120709&bid=263057&dat=121642
> >> _______________________________________________
> >> Jsdoc-user mailing list
> >> Jsd...@li...
> >> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
> >>
> >
> > +-----------------------------------------------------------------+
> > |Paul Spencer                          psp...@dm...    |
> > +-----------------------------------------------------------------+
> > |Chief Technology Officer                                         |
> > |DM Solutions Group Inc                http://www.dmsolutions.ca/ |
> > +-----------------------------------------------------------------+
> >
> >
> >
> >
> >
> >
> -------------------------------------------------------------------------
> > Using Tomcat but need to do more? Need to support web services,
> security?
> > Get stuff done quickly with pre-integrated technology to make your job
> easier
> > Download IBM WebSphere Application Server v.1.0.1 based on Apache
> Geronimo
> > http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
> > _______________________________________________
> > Jsdoc-user mailing list
> > Jsd...@li...
> > https://lists.sourceforge.net/lists/listinfo/jsdoc-user
> >
> >
>
>
> -------------------------------------------------------------------------
> Using Tomcat but need to do more? Need to support web services, security?
> Get stuff done quickly with pre-integrated technology to make your job
> easier
> Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>

Re: [Jsdoc-user] [JSDoc 2 is now in the Initial Planning Phase -- Haveat it!]

[Marc R. B. R. <mar...@ua...>]

Paul Spencer wrote:
> Gabriel,
>
> for me, the most pressing need is for something that can work with  
> Prototype.js (http://prototype.conio.net) style coding.  I think  
> jsdoc already has excellent features for its output, but it is  
> essentially unusable for me as I am using Prototype as my base  
> library.  It would also be awesome just for documenting Prototype :)
>
> Cheers
>   

+100 to Paul's suggestion. :-)

JSdoc is wonderful, but when I finish my developments I need to reedit 
my code in a way JSDoc could document it.

I think prototype library is becoming a "facto" standard for JS developers.
> Paul
>
> On 16-Oct-06, at 11:30 AM, Gabriel Reid wrote:
>
>   
>> Hi Everyone,
>>
>> I'm just passing on this announcement from Michael Mathews about a  
>> second
>> incarnation of JSDoc that is currently in the planning phase. We're  
>> hoping
>> to address the many shortcomings of the current version of JSDoc,  
>> but we
>> first need to get feedback from everyone who is using the tool.
>>
>> If you have any JavaScript documenting wants or needs that JSDoc isn't
>> currently addressing, now is your chance to let yourself be heard!
>>
>> The discussion can be found at <http://groups.google.com/group/ 
>> jsdoc-2>.
>>
>> Looking forward to hearing from you!
>>
>>
>> Regards,
>>
>>     Gabriel Reid
>>
>>
>> ----- Forwarded message  -----
>>
>> ANNOUNCEMENT: For quite a long time now Gabriel Reid has been laboring
>> valiently to keep up with the evolving needs and requests of the JSDoc
>> users, burdened by a general design which simply wasn't flexible  
>> enough
>> to easily handle the new world of JavaScript we now find ourselves in.
>>
>> I take full responsibility for getting Gabriel into this situation and
>> want to make what ammends I can by helping to design a new, more
>> powerful, flexible and extensable version for the future. JSDoc 2.0
>> will be a ground-up rebuild with the paramount intention of handling
>> more variations in code and style than was possible in JSDoc 1.
>>
>> So, while the clay is still wet and gooey, you are highly  
>> encouraged to
>> stick a finger into the shape of what JSDoc 2 will be. What have you
>> always wanted but couldn't have in your JS documentation? Any and all
>> suggestions will be considered and, if the case is good, will be
>> implemented.
>>
>>
>> ----- End forwarded message -----
>>
>> ---------------------------------------------------------------------- 
>> ---
>> Using Tomcat but need to do more? Need to support web services,  
>> security?
>> Get stuff done quickly with pre-integrated technology to make your  
>> job easier
>> Download IBM WebSphere Application Server v.1.0.1 based on Apache  
>> Geronimo
>> http://sel.as-us.falkag.net/sel? 
>> cmd=lnk&kid=120709&bid=263057&dat=121642
>> _______________________________________________
>> Jsdoc-user mailing list
>> Jsd...@li...
>> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>>     
>
> +-----------------------------------------------------------------+
> |Paul Spencer                          psp...@dm...    |
> +-----------------------------------------------------------------+
> |Chief Technology Officer                                         |
> |DM Solutions Group Inc                http://www.dmsolutions.ca/ |
> +-----------------------------------------------------------------+
>
>
>
>
>
> -------------------------------------------------------------------------
> Using Tomcat but need to do more? Need to support web services, security?
> Get stuff done quickly with pre-integrated technology to make your job easier
> Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>
>   

Re: [Jsdoc-user] [JSDoc 2 is now in the Initial Planning Phase -- Have at it!]

[Michael M. <mi...@gm...>]

Hi Paul,

I think it's pretty safe to say JSDoc 2 will support Prototype. The only
question is how to best implement that support. You can help: send me a
typical file of Prototype JS you've written and can't get JSDoc 1 to work
with. I'll make that part of a unit test and start planning how to support
that syntax. (I've never actually used Prototype myself)

It may be as simple as writing some detailed documentation on how to get the
current tool to work with Prototype's syntax, but if, as I suspect, the
JSDoc tool itself needs to be modified, we'll make that a priority.

Also would you volunteer to run tests on any new release candidates to
confirm that they work against your Prototype code?

regards,
Michael <mi...@gm...>

On 18/10/06, Paul Spencer <psp...@dm...> wrote:
>
> Gabriel,
>
> for me, the most pressing need is for something that can work with
> Prototype.js (http://prototype.conio.net) style coding.  I think
> jsdoc already has excellent features for its output, but it is
> essentially unusable for me as I am using Prototype as my base
> library.  It would also be awesome just for documenting Prototype :)
>
> Cheers
>
> Paul
>
> On 16-Oct-06, at 11:30 AM, Gabriel Reid wrote:
>
> > Hi Everyone,
> >
> > I'm just passing on this announcement from Michael Mathews about a
> > second
> > incarnation of JSDoc that is currently in the planning phase. We're
> > hoping
> > to address the many shortcomings of the current version of JSDoc,
> > but we
> > first need to get feedback from everyone who is using the tool.
> >
> > If you have any JavaScript documenting wants or needs that JSDoc isn't
> > currently addressing, now is your chance to let yourself be heard!
> >
> > The discussion can be found at <http://groups.google.com/group/
> > jsdoc-2>.
> >
> > Looking forward to hearing from you!
> >
> >
> > Regards,
> >
> >     Gabriel Reid
> >
> >
> > ----- Forwarded message  -----
> >
> > ANNOUNCEMENT: For quite a long time now Gabriel Reid has been laboring
> > valiently to keep up with the evolving needs and requests of the JSDoc
> > users, burdened by a general design which simply wasn't flexible
> > enough
> > to easily handle the new world of JavaScript we now find ourselves in.
> >
> > I take full responsibility for getting Gabriel into this situation and
> > want to make what ammends I can by helping to design a new, more
> > powerful, flexible and extensable version for the future. JSDoc 2.0
> > will be a ground-up rebuild with the paramount intention of handling
> > more variations in code and style than was possible in JSDoc 1.
> >
> > So, while the clay is still wet and gooey, you are highly
> > encouraged to
> > stick a finger into the shape of what JSDoc 2 will be. What have you
> > always wanted but couldn't have in your JS documentation? Any and all
> > suggestions will be considered and, if the case is good, will be
> > implemented.
> >
> >
> > ----- End forwarded message -----
> >
> > ----------------------------------------------------------------------
> > ---
> > Using Tomcat but need to do more? Need to support web services,
> > security?
> > Get stuff done quickly with pre-integrated technology to make your
> > job easier
> > Download IBM WebSphere Application Server v.1.0.1 based on Apache
> > Geronimo
> > http://sel.as-us.falkag.net/sel?
> > cmd=lnk&kid=120709&bid=263057&dat=121642
> > _______________________________________________
> > Jsdoc-user mailing list
> > Jsd...@li...
> > https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>
> +-----------------------------------------------------------------+
> |Paul Spencer                          psp...@dm...    |
> +-----------------------------------------------------------------+
> |Chief Technology Officer                                         |
> |DM Solutions Group Inc                http://www.dmsolutions.ca/ |
> +-----------------------------------------------------------------+
>
>
>
>
>
> -------------------------------------------------------------------------
> Using Tomcat but need to do more? Need to support web services, security?
> Get stuff done quickly with pre-integrated technology to make your job
> easier
> Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>

Re: [Jsdoc-user] [JSDoc 2 is now in the Initial Planning Phase -- Have at it!]

[Paul S. <psp...@dm...>]

Gabriel,

for me, the most pressing need is for something that can work with  
Prototype.js (http://prototype.conio.net) style coding.  I think  
jsdoc already has excellent features for its output, but it is  
essentially unusable for me as I am using Prototype as my base  
library.  It would also be awesome just for documenting Prototype :)

Cheers

Paul

On 16-Oct-06, at 11:30 AM, Gabriel Reid wrote:

> Hi Everyone,
>
> I'm just passing on this announcement from Michael Mathews about a  
> second
> incarnation of JSDoc that is currently in the planning phase. We're  
> hoping
> to address the many shortcomings of the current version of JSDoc,  
> but we
> first need to get feedback from everyone who is using the tool.
>
> If you have any JavaScript documenting wants or needs that JSDoc isn't
> currently addressing, now is your chance to let yourself be heard!
>
> The discussion can be found at <http://groups.google.com/group/ 
> jsdoc-2>.
>
> Looking forward to hearing from you!
>
>
> Regards,
>
>     Gabriel Reid
>
>
> ----- Forwarded message  -----
>
> ANNOUNCEMENT: For quite a long time now Gabriel Reid has been laboring
> valiently to keep up with the evolving needs and requests of the JSDoc
> users, burdened by a general design which simply wasn't flexible  
> enough
> to easily handle the new world of JavaScript we now find ourselves in.
>
> I take full responsibility for getting Gabriel into this situation and
> want to make what ammends I can by helping to design a new, more
> powerful, flexible and extensable version for the future. JSDoc 2.0
> will be a ground-up rebuild with the paramount intention of handling
> more variations in code and style than was possible in JSDoc 1.
>
> So, while the clay is still wet and gooey, you are highly  
> encouraged to
> stick a finger into the shape of what JSDoc 2 will be. What have you
> always wanted but couldn't have in your JS documentation? Any and all
> suggestions will be considered and, if the case is good, will be
> implemented.
>
>
> ----- End forwarded message -----
>
> ---------------------------------------------------------------------- 
> ---
> Using Tomcat but need to do more? Need to support web services,  
> security?
> Get stuff done quickly with pre-integrated technology to make your  
> job easier
> Download IBM WebSphere Application Server v.1.0.1 based on Apache  
> Geronimo
> http://sel.as-us.falkag.net/sel? 
> cmd=lnk&kid=120709&bid=263057&dat=121642
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user

+-----------------------------------------------------------------+
|Paul Spencer                          psp...@dm...    |
+-----------------------------------------------------------------+
|Chief Technology Officer                                         |
|DM Solutions Group Inc                http://www.dmsolutions.ca/ |
+-----------------------------------------------------------------+

[Jsdoc-user] [JSDoc 2 is now in the Initial Planning Phase -- Have at it!]

[Gabriel R. <gab...@gm...>]

Hi Everyone,

I'm just passing on this announcement from Michael Mathews about a second 
incarnation of JSDoc that is currently in the planning phase. We're hoping 
to address the many shortcomings of the current version of JSDoc, but we 
first need to get feedback from everyone who is using the tool.

If you have any JavaScript documenting wants or needs that JSDoc isn't
currently addressing, now is your chance to let yourself be heard!

The discussion can be found at <http://groups.google.com/group/jsdoc-2>.

Looking forward to hearing from you!


Regards,

    Gabriel Reid


----- Forwarded message  -----

ANNOUNCEMENT: For quite a long time now Gabriel Reid has been laboring
valiently to keep up with the evolving needs and requests of the JSDoc
users, burdened by a general design which simply wasn't flexible enough
to easily handle the new world of JavaScript we now find ourselves in.

I take full responsibility for getting Gabriel into this situation and
want to make what ammends I can by helping to design a new, more
powerful, flexible and extensable version for the future. JSDoc 2.0
will be a ground-up rebuild with the paramount intention of handling
more variations in code and style than was possible in JSDoc 1.

So, while the clay is still wet and gooey, you are highly encouraged to
stick a finger into the shape of what JSDoc 2 will be. What have you
always wanted but couldn't have in your JS documentation? Any and all
suggestions will be considered and, if the case is good, will be
implemented.


----- End forwarded message -----

Re: [Jsdoc-user] Can this is possible with JsDoc

[Jagadesh P. <jag...@gm...>]

Thanks Gabriel.

Can I get all the switches(options) for generating the documentation. I feel
with those options I can get my requirements done eaisly, If you have the
link just pass it to me.

- Jagadesh



On 10/6/06, Gabriel Reid <gab...@gm...> wrote:
>
> Hi,
>
> > In JsDoc in FileOverview option, the user is able to see the complete
> > source
> > file when he clicks on the file name. Is this a genuine requirement. (
> Are
> > any one using this requirement?)
> >
> > I need help regarding this issue. I don't want this feature in my
> > documentation, can I generate documentation without this feature. If it
> is
> > possible, just reply me how to disable the feature, as soon as possible.
>
> Yes, it's possible to run JSDoc without creating the sourcecode view;
> use the --no-sources option on the commandline.
>
> - Gabriel
>

Re: [Jsdoc-user] Can this is possible with JsDoc

[Gabriel R. <gab...@gm...>]

Hi,

> In JsDoc in FileOverview option, the user is able to see the complete 
> source
> file when he clicks on the file name. Is this a genuine requirement. ( Are
> any one using this requirement?)
> 
> I need help regarding this issue. I don't want this feature in my
> documentation, can I generate documentation without this feature. If it is
> possible, just reply me how to disable the feature, as soon as possible.

Yes, it's possible to run JSDoc without creating the sourcecode view;
use the --no-sources option on the commandline.

- Gabriel

[Jsdoc-user] Can this is possible with JsDoc

[Jagadesh P. <jag...@gm...>]

Hello everyone,

I am very new to JsDoc. Js Doc is very superb documentaion tool. But I have
a doubt regarding JsDoc.

In JsDoc in FileOverview option, the user is able to see the complete source
file when he clicks on the file name. Is this a genuine requirement. ( Are
any one using this requirement?)

I need help regarding this issue. I don't want this feature in my
documentation, can I generate documentation without this feature. If it is
possible, just reply me how to disable the feature, as soon as possible.

Thanks and Regards,
Jagadesh Paladugula

[Jsdoc-user] Class or member number limit

[Dave J. <da...@ni...>]

Hello,

I have about 1000 classes, methods, properties that I need documented 
but JSDoc is just says "loading sources from grid.js" and then it 
finishes without making my docs.

Is there some limit to the number of class/members that it can docuement?

Cheers,
dave

[Jsdoc-user] @package tag and static object

[<s.c...@wa...>]

Hello,

I try to use @package  but JSDOC doesn't generate nothing except
summary. I've put bellow my source code

I use this command line to launch process :
C:\>perl jsdoc/jsdoc.pl --project-name Concentre --package-naming -r -d
../doc/javascript  ../share/concentre/

I'm not sure to understand "--package-naming" arguments

Moreover, I would like to know if it exists a mean to declare=20
private/public vars  and static vars/method.
In my code bellow I would like to declare as private  "xliff" var and
"message", "regexp" objects.

My project uselot of "static" Object that are faster than dynamic. It's
a command way to declare static object  as this.

I hope that someone could help me
Thanks

Regards

S=E9bastien

----------------------------- my code ------------------------------

/**
 * @fileoverview This file add support for XLIFF Internationalization
(I18N) file
 *
 * @author S=E9bastien Cramatte scr...@ze...
 * @version 0.1
 */

/** @package ConcentreFactory.i18n */
/** @class */
ConcentreFactory.i18n =3D {
   =20
    xliff : null,
    messages : {},   =20

    regex : new RegExp(/%s/g),

 /**
  * Load XLiff resource file
  * @param {string} XLiff source file uri
  */
    load : function (src) {
        this.xliff =3D XMLDocument.loadURI(src);
    },

 /**
  * Return translated String
  * @param {string} XLiff @resname attribute
  * @param {array} Replace all %s by array values
  * @type String
  * @return Translated string
  */
    translate : function (res, attrs)    {
        if (!this.messages[res]) {
            this.messages[res] =3D SimpleXPATH.evaluate(this.xliff,
this.xliff.documentElement,"/xliff/file/body/trans-unit[@resname=3D'"+res=
+"']/source/text()").iterateNext().nodeValue;
        }
           =20
       =20
        return this.messages[res].replace(i18n.regex, function (e) {
return attrs[i18n.regex.lastIndex] } );

    }
};

Re: [Jsdoc-user] Private members without default values don't work?

[Gabriel R. <gab...@gm...>]

On Tue, Sep 12, 2006 at 02:17:23PM -0400, Al Vazquez wrote:
> I've got a constructor that looks like:
> 
> function C()
> {
>   var x;
>   var y;
> 
>   this.accessorY = function() { return y;}
> }
> 
> When I run jsdoc against this file, x and y don't show up, but if I
> change the lines from:
> 
> var x;
> 
> to:
> 
> var x = 1;
> 
> then jsdoc picks it up. Anyone have any insight into this? What file
> might I patch to fix this?
> 

You would have to alter JSDoc.pm to change this behaviour, in the function
"deconstruct_inner_constructor". Search for the block that is run
conditionally on the config setting "NO_LEXICAL_PRIVATES".

- Gabriel

[Jsdoc-user] Private members without default values don't work?

[Al V. <al....@gm...>]

I've got a constructor that looks like:

function C()
{
  var x;
  var y;

  this.accessorY = function() { return y;}
}

When I run jsdoc against this file, x and y don't show up, but if I
change the lines from:

var x;

to:

var x = 1;

then jsdoc picks it up. Anyone have any insight into this? What file
might I patch to fix this?

--Al Vazquez

[Jsdoc-user] One way of createing static methods is ignored

[Miles C. <mcrawfor@u.washington.edu>]

When I create a static method like this:

Example.method = Example_method;
function Example_method () {
   alert('foo');
}

JSDoc picks up the method and the comments associated.

However, if I write the equivalent:

Example.method = function () {
   alert('foo');
}

JSDoc appears to comeplety ignore the method.

Is there a reason for this?  I find the second syntax for creating class 
methods far preferable in terms of cleanliness, so I would love if JSDoc 
supported it.

Could anyone who understands the JSDoc code provide me a patch I could use 
locally?

-miles

Re: [Jsdoc-user] Indicating a getter that might throw?

[Gabriel R. <gab...@gm...>]

> I've noticed that lots of things available for documenting methods are
> not available for properties (e.g., @see).  But that's usually
> workable...
> 
> Except now I have a getter that can throw.  So, | var a = foo.bar |
> can throw... Is there a way for me to document that?  @throws seems to
> be one of those things not available for properties.

Could you register this as a feature request on the SourceForge project
page (sourceforge.net/projects/jsdoc)?  This kind of construction should be 
pretty simple to add, but I don't have time to do it right away and I
don't want to forget. As you'll notice, there are already quite a few
pending feature requests; it is my intention to take care of a large
number of these eventually, but I'm sorry to say it's not going to happen 
terribly quickly.

Regards,

    Gabriel

[Jsdoc-user] Indicating a getter that might throw?

[Mook <moo...@gm...>]

Hi,

I've noticed that lots of things available for documenting methods are
not available for properties (e.g., @see).  But that's usually
workable...

Except now I have a getter that can throw.  So, | var a = foo.bar |
can throw... Is there a way for me to document that?  @throws seems to
be one of those things not available for properties.

Thanks, and thanks for actually writing jsdoc :)

(P.S. Mozilla now also has a new syntax for getters/setters in object
initializers... It's not supported in JSDoc, but at least that's
supported; see
http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Guide:Creating_New_Objects:Defining_Getters_and_Setters
)

Sample code:

function a() {}
/**
 * Test
 * @throws Error foo
 */
a.prototype.__defineGetter__("b", function(){});

-- 
Mook
mook dot moz plus stuff at gmail

Re: [Jsdoc-user] Documenting and oject

[Gabriel R. <gab...@gm...>]

> >your
> >code can be slightly changed (without changing the functionality of it)
> >to allow it to be documented by JSDoc, as shown below:
> >
> >var foo;
> >foo = new function(){
> >    this.bar = function(){};
> >};
> >
> >I'm not too crazy about the idea of users having to change their code to
> >adapt to the tool, but as I said, that's the current situation.
> 
> No, I  don't want to change my code to enable the JSDoc tool to pick
> up the docs. I've seen that the Yahoo! UI uses a trick similar to
> this.
> 
> Is there a move to add this functionality to JSDoc? It seems essential
> to documenting JavaScript code.

I suppose you could say that there is very slight motion in the
direction of supporting this, but it won't be happening today or
tomorrow.

The original intention of JSDoc was to document prototype/class/object
-oriented JavaScript. It has been adapted more and more along the way to
try to handle broader needs such as the one you're describing, but now
it has gotten quite difficult to handle adding functionality like this. 

The "slight motion" that I refer to is the (partial) re-implementation
of JSDoc using a real JavaScript parser/interpreter, instead of fumbling
around with regexes as is done now. I would say that this is in the
general planning phase right now (and has been for a while now), which
is why the functionality that you're talking about won't be ready in the
very near future.

Regards,

    Gabriel

Re: [Jsdoc-user] Documenting and oject

[Gabriel R. <gab...@gm...>]

Hi,

> I have been happily using JSDoc to document my JavaScript "classes".
> Can I document a JavaScript object created with an object literal?
> Something like
> 
> /**
>  * @object
>  *
>  * This is my foo object.
>  */
> var foo = {
>   /**
>    * The bar function property.
>    */
>   bar: function(){},
>   /**
>    * The barbar array property.
>    */
>   barbar: []
> };
> 

Unfortunately, no, the current version of JSDoc doesn't document global
objects like this, although it does seem to be something that is asked
for quite often.

As was pointed out by Ian Peterson earlier today on this list, your
code can be slightly changed (without changing the functionality of it)
to allow it to be documented by JSDoc, as shown below:

var foo;
foo = new function(){
    this.bar = function(){};
};

I'm not too crazy about the idea of users having to change their code to
adapt to the tool, but as I said, that's the current situation.

Regards,

    Gabriel

[Jsdoc-user] Documenting and oject

[Peter M. <pet...@gm...>]

Hi,

I have been happily using JSDoc to document my JavaScript "classes".
Can I document a JavaScript object created with an object literal?
Something like

/**
 * @object
 *
 * This is my foo object.
 */
var foo = {
  /**
   * The bar function property.
   */
  bar: function(){},
  /**
   * The barbar array property.
   */
  barbar: []
};

Thanks,
Peter

[Jsdoc-user] Fwd: JSON object containing functions

[Ian P. <isp...@gm...>]

Sorry, should have sent this to the list.

---------- Forwarded message ----------
From: Ian Petersen <isp...@gm...>
Date: Aug 8, 2006 9:51 PM
Subject: Re: [Jsdoc-user] JSON object containing functions
To: Ryan Parman <sky...@ya...>


You can change the syntax to look like this:

var favorites;

favorites = new function() {
    this.loadMe = function() {
        // loadMe implementation here
    };

    // keep going, changing
    // foo: bar
    // to
    // this.foo = bar
};

It's functionally equivalent, gives you the ability to create really
private variables, if you like, and allows JSDoc to document the whole
thing.

Ian

On 8/8/06, Ryan Parman <sky...@ya...> wrote:
> I have some functions that I want to document, but
> because they're within an object, JSDoc won't document
> it.  Here's a sample:
>
> /**
>  * This is the parent container for all of the
> functions relating to this portlet.
>  * @author Ryan Parman
>  * @version 20060807
>  */
> var favorites = {
>         /**
>          * This is the function that gets fired when the
> portlet loads.  Anything that needs to fire with the
> portlet load MUST be called within this function.
>          * @author Ryan Parman
>          * @version 20060807
>          */
>         loadMe:function() {
>                 // Hide items that need to be hidden by default
>                 this.defaultHide();
>
>                 // Read JSON object and generate lists
>                 this.buildListNode(jsonListItems);
>
>                 // Make the lists sortable
>                 this.makeSortable();
>
>                 // Apply event handlers
>                 Behaviour.register(favorites_rules);
>
>                 // Set these up for canceling
>                 var FAVORITES_CURRENT_ACTIVE=null;
>                 var FAVORITES_CURRENT_INACTIVE=null;
>         },
>
>
>         /**
>          * Hide the elements that need to be hidden by
> default.
>          * @author Ryan Parman
>          * @version 20060807
>          */
>         defaultHide:function() {
>                 Element.hide('edit-controls');
>                 Element.hide('save-controls');
>                 Element.hide('add_panel');
>                 $('add_submit').disabled=true;
>         }
> }
>
> If I change "var favorites" to "function favorites()",
> I'll get the documentation generated, but the
> JavaScript syntax doesn't work right (favorites.loadMe()).
>
> __________________________________________________
> Do You Yahoo!?
> Tired of spam?  Yahoo! Mail has the best spam protection around
> http://mail.yahoo.com
>
> -------------------------------------------------------------------------
> Using Tomcat but need to do more? Need to support web services, security?
> Get stuff done quickly with pre-integrated technology to make your job easier
> Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>


--
Tired of pop-ups, security holes, and spyware?
Try Firefox: http://www.getfirefox.com


-- 
Tired of pop-ups, security holes, and spyware?
Try Firefox: http://www.getfirefox.com

[Jsdoc-user] JSON object containing functions

[Ryan P. <sky...@ya...>]

I have some functions that I want to document, but
because they're within an object, JSDoc won't document
it.  Here's a sample:

/**
 * This is the parent container for all of the
functions relating to this portlet.
 * @author Ryan Parman
 * @version 20060807
 */
var favorites = {
	/**
	 * This is the function that gets fired when the
portlet loads.  Anything that needs to fire with the
portlet load MUST be called within this function.
	 * @author Ryan Parman
	 * @version 20060807
	 */
	loadMe:function() {
		// Hide items that need to be hidden by default
		this.defaultHide();

		// Read JSON object and generate lists
		this.buildListNode(jsonListItems);

		// Make the lists sortable
		this.makeSortable();

		// Apply event handlers
		Behaviour.register(favorites_rules);

		// Set these up for canceling
		var FAVORITES_CURRENT_ACTIVE=null;
		var FAVORITES_CURRENT_INACTIVE=null;
	},


	/**
	 * Hide the elements that need to be hidden by
default.
	 * @author Ryan Parman
	 * @version 20060807
	 */
	defaultHide:function() {
		Element.hide('edit-controls');
		Element.hide('save-controls');
		Element.hide('add_panel');
		$('add_submit').disabled=true;
	}
}

If I change "var favorites" to "function favorites()",
I'll get the documentation generated, but the
JavaScript syntax doesn't work right (favorites.loadMe()).

__________________________________________________
Do You Yahoo!?
Tired of spam?  Yahoo! Mail has the best spam protection around 
http://mail.yahoo.com