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

Re: [Jsdoc-user] Hiding constructor details

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

On Sat, Mar 24, 2007 at 04:07:14PM +0000, Bruce Boughton wrote:
> Hi,
> 
> I'm using JSDoc to document a public API I am creating.  Some of the 
> objects I am documenting will not be instantiable by the user.  These 
> objects may be obtained via other public methods, so it is important to 
> document their methods. I would like to hide their constructor details 
> though.  If I add the @ignore or @private tags to the constructor 
> documentation block (which contains the class documentation), the entire 
> class is omitted.  If I omit the constructor documentation entirely, I 
> cannot add class documentation.
> 

Hi Bruce,

I think I know what you mean with your explanation of what you want, but
the code that you posted has got me a bit confused. Which is the
constructor method whose details you want to hide? And where are you
putting the @ignore tag? 

My guess was that TEST.TestInstance is the function whose details you
want to hide, but if I run it through JSDoc I still don't see the kind
of problems that you're running into.

Could you provide a bit more explanation, or another example (pointing
out the information that you want to be hidden, and where you're putting
the @ignore or @private tag)?

- Gabriel

Re: [Jsdoc-user] Documenting JavaScript Innter Types

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

On Fri, Mar 09, 2007 at 10:16:06AM -0800, Aaron Swain wrote:
> Hi, just wondering if JSDoc supports inner types at all?  For example:
> 
>  
> 
> var myClass = {
> 
>             setter: function(){},
> 
>             getter: function(){}
> 
> }
> 

Hi,

Sorry for such a late response. In any case, JSDoc (the first version) doesn't 
support documenting code exactly as you wrote it. The main background
behind that is that only "re-usable class-style constructs" are
documented, and not instance variables (as shown in your example).

Similar (but obviously not exactly the same) constructs are supported,
as shown below:

    function myclass(){}

    myclass.prototype = {
        myfuncOne: function(){
            return null;
        }
    };

> 
> Or if anyone knows/has something that will support this?
> 

I assume you've already heard from Michael, but if not: I believe that
this is taken care of by JSDoc-2.

Regards,

    Gabriel

Re: [Jsdoc-user] JSDoc generating thinks one of my methods is a subclass.

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

On Thu, Mar 08, 2007 at 10:35:31AM -0800, Leslie Freeman wrote:
> Hello,
> I've recently started using JSDoc and been very pleased. I have run  
> into one slight problem though. When I run JSDoc on the following  
> code, it generates class documentation for ImageLoader and  
> ImageLoader.ininitlize. initilize is a method and not a class. What  
> do I need to do do my code to stop JSDoc from being confused?
> Note: it is not generating a class doc for ImageLoader.onImageLoad,  
> only for .initilize
...

> 	/**
> 	 * Construct a new ImageLoader object. Begins image loading.
> 	 *<p>
> 	 * Options:<br>
> 	 * <li>container - an element, such as a div, to display the image  
> in. If a container is specified ImageLoader will also display a  
> loading image.
> 	 * <li>beforeLoad - a command to be excecuted before loading starts
> 	 * <li>afterLoad - a command to be excecuted when the image is loaded
>           *
> 	 * @class This is the ImageLoader class.
> 	 * @param {String} image_url The URL of the image to load.
> 	 * @param {Array} options An array of 'key':'value' option pairs --  
> see description.
> 	 * @constructor
> 	 */
> 	initialize: function(image_url, options) {
> 		//function code
> 	},

Hi,

Sorry for only replying to this now; I've been very out of touch with
this project as of late and I'm just now going through these mails to
try to clear out some of these issues.

The solution here is that you just have to remove the @class and
@constructor tags from the documentation for the "initialize" function.
These tags are normally used to give JSDoc a hint that a function is
actually the constructor function for a class (and to therefore ensure
that the class is recognized as such), but here they're making JSDoc
think that initialize is itself a function. In any case, by removing
these two tags it should be cleared up.


Gabriel

[Jsdoc-user] Hiding constructor details

[Bruce B. <br...@br...>]

Hi,

I'm using JSDoc to document a public API I am creating.  Some of the 
objects I am documenting will not be instantiable by the user.  These 
objects may be obtained via other public methods, so it is important to 
document their methods. I would like to hide their constructor details 
though.  If I add the @ignore or @private tags to the constructor 
documentation block (which contains the class documentation), the entire 
class is omitted.  If I omit the constructor documentation entirely, I 
cannot add class documentation.

What should I be doing to hide only my constructors? I show sample code 
below:

/**
 * @class A TestInstance object is...
 */
TEST.TestInstance = function(identifier) {
    this.init(identifier);
};

TEST.TestInstance.prototype = {

  init: function(identifier) {

     var id = identifier;

     this._foo = function() {
      alert(id);
     };

  },

  /**
   * Alert the identifier.
   * @method Foo
   */
  foo: function() {
   return this._foo();
  }

};

Bruce

Re: [Jsdoc-user] Documenting JavaScript Innter Types

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

Hi  Aaron,

I can tell you that this is possible using JSDoc-2. I've posted a  
working example of how at this URL:

	http://www.jsdoc.info/export/examples/html/picky.html (pick  
"aaron.js" from the drop-menu)

Note that the above website is not "officially" available yet, but  
will soon contain a gallery of working examples and downloadable  
templates. Just thought you might want to see a little preview of how  
your particular example would work.

The source code is:

/**
   myClass - This is my class.
*/
var myClass = {
	/** myClass.setter - Set this. */
	setter: function(){},

	/** myClass.getter - Get this.*/
	getter: function(){}
}

Have a look at the JSDoc-2 wiki for more information on JSDoc-2  
syntax or reply to the mailing list (in the cc) with specific questions.

	http://code.google.com/p/jsdoc-2/

Also, if any other code samples are posted to the list, I'll try to  
add those to the gallery too.

Regards,
Michael

On 9 Mar 2007, at 18:16, Aaron Swain wrote:

> Hi, just wondering if JSDoc supports inner types at all?  For example:
>
>
>
> var myClass = {
>
>             setter: function(){},
>
>             getter: function(){}
>
> }
>
>
>
> Or if anyone knows/has something that will support this?
>
>
>
> Thanks,
>
>
>
> Aaron
>
> ---------------------------------------------------------------------- 
> ---
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to  
> share your
> opinions on IT & business topics through brief surveys-and earn cash
> http://www.techsay.com/default.php? 
> page=join.php&p=sourceforge&CID=DEVDEV________________________________ 
> _______________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user

[Jsdoc-user] Documenting JavaScript Innter Types

[Aaron S. <as...@th...>]

Hi, just wondering if JSDoc supports inner types at all?  For example:

 

var myClass = {

            setter: function(){},

            getter: function(){}

}

 

Or if anyone knows/has something that will support this?

 

Thanks,

 

Aaron

[Jsdoc-user] JSDoc generating thinks one of my methods is a subclass.

[Leslie F. <le...@su...>]

Hello,
I've recently started using JSDoc and been very pleased. I have run  
into one slight problem though. When I run JSDoc on the following  
code, it generates class documentation for ImageLoader and  
ImageLoader.ininitlize. initilize is a method and not a class. What  
do I need to do do my code to stop JSDoc from being confused?
Note: it is not generating a class doc for ImageLoader.onImageLoad,  
only for .initilize


/**
* @fileoverview This file defines the ImageLoader class.
*
* @author Leslie Freeman le...@su...
* @version 0.1
*/

var ImageLoader = Class.create();

ImageLoader.prototype = {
	/**
	 * Construct a new ImageLoader object. Begins image loading.
	 *<p>
	 * Options:<br>
	 * <li>container - an element, such as a div, to display the image  
in. If a container is specified ImageLoader will also display a  
loading image.
	 * <li>beforeLoad - a command to be excecuted before loading starts
	 * <li>afterLoad - a command to be excecuted when the image is loaded
          *
	 * @class This is the ImageLoader class.
	 * @param {String} image_url The URL of the image to load.
	 * @param {Array} options An array of 'key':'value' option pairs --  
see description.
	 * @constructor
	 */
	initialize: function(image_url, options) {
		//function code
	},
	
	/**
	 * Performs functions after the image is loaded. Should not be  
called directly. If you need to execute a callback, use the afterLoad  
option to the {@link #initilize constructor}.
	 */
	onImageLoad: function(){
		//function code
	}
};

Thanks,
Leslie Freeman

Re: [Jsdoc-user] Fwd: adding code sample/snippet to jsdoc

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

Hi Kate,

I assumed everyone knew to look under the "Source" tab of the google  
project page: http://code.google.com/p/jsdoc-2/source

But I guess it's not all that obvious now that I look at it. Anyway  
it was about time anyway, so I wrapped up a nice tarball and called  
it beta 0.1. It's under the "Files" tab: http://code.google.com/p/ 
jsdoc-2/downloads/list

I should celebrate now, because as of about 6 minutes ago JSDoc-2 is  
officially out of alpha, and into beta! I'm too tired though so I'm  
going to bed. Funny what the idea of "celebrating" becomes as one  
gets older...

Regards,
Michael

PS I'm looking forward to your help making JSDoc-2 the best possible  
JSDoc-2 final release we can.

On 6 Mar 2007, at 20:04, Rodrigues, Kate wrote:

> Sure, I am happy to provide feedback for JSDoc-2. Where can I  
> download a
> trial version? I'm sure I'm overlooking the obvious, but I've gone to
> http://code.google.com/p/jsdoc-2/ and can't see the download area.
>
> Thanks,
> kate
>
> -----Original Message-----
> From: Michael Mathews [mailto:mi...@gm...]
> Sent: Friday, March 02, 2007 2:27 PM
> To: Rodrigues, Kate
> Cc: jsd...@li...; js...@go...
> Subject: Re: [Jsdoc-user] Fwd: adding code sample/snippet to jsdoc
>
> Wait? Absolutely not! Don't wait. Join the JSDoc-2 group right now
> and perhaps give us a hand with the work! :-)
>
> Seriously though I've been playing with jsdoc-2 for months now and
> would consider it quite usable already. I'm probably a little biased
> in that regard but that's why I need folks like yourself to take a
> look and share their feedback.
>
> I look forward to seeing you in the group! http://code.google.com/p/
> jsdoc-2/
>
> Regards,
> Michael
>
>
> On 2 Mar 2007, at 21:02, Rodrigues, Kate wrote:
>
>> My knowledge of perl is next to nothing. Should I wait for JSDoc-2
>> to be released rather than try to figure out how to add a custom
>> @example tag to the current JSDoc-1 config file?
>>
>> thanks!
>> kate
>>
>> ________________________________
>>
>> From: Gabriel Reid [mailto:gab...@gm...]
>> Sent: Fri 3/2/2007 12:28 PM
>> To: jsd...@li...
>> Cc: Rodrigues, Kate
>> Subject: Re: [Jsdoc-user] Fwd: adding code sample/snippet to jsdoc
>>
>>
>>
>> Hi,
>>
>> As Michael pointed out, JSDoc-2 has much stronger support for custom
>> constructs such as this one. However, JSDoc 1 also has very basic
>> support for this as well, in the not-very-well-known .jsdoc_config
>> file.
>> Adding support for new tags *does* require that you have at least a
>> basic
>> understanding of perl, as this configuration file consists of perl
>> callbacks for custom tags.
>>
>> On the other hand, of course, you could simply put the example code
>> inside of <code> tags, which might just be sufficient.
>>
>> Regards,
>>
>>     Gabriel
>>
>>
>> On Fri, Mar 02, 2007 at 07:40:07AM +0000, Michael Mathews wrote:
>>> Hi,
>>>
>>> Gabriel can answer for JSDoc 1.x but because JSDoc-2 doesn't pick  
>>> and
>>> choose which tags it will process, you very well could invent an
>>> @example tag. In that case the example text would be passed into the
>>> template as-is.
>>>
>>> If your template produced HTML, then there is nothing to stop you
>>> from having any HTML tags you wanted in the body of your example  
>>> tag.
>>> In JSDoc-2 your tag could look like this:
>>>
>>> /**
>>> nlapiCreateRecord - Initializes a new record and returns an
>>> nlobjRecord containing all the default field data for that record
>>> type
>>> @param type - record type for the record
>>> @example The following example initializes a new opportunity record.
>>> <code>
>>> var record = nlapiCreateRecord('opportunity')
>>> var defaultstatus = record.getFieldValue('entitystatus')
>>> </code>
>>> */
>>> function nlapiCreateRecord(type) { ; }
>>>
>>> But we are still developing JSDoc-2. When the first beta is released
>>> (any day now!) I'll include an example of how to write a template to
>>> handle example tags.
>>>
>>> Regards,
>>> Michael
>>>>
>>>> On 1 Mar 2007, at 23:07, Rodrigues, Kate wrote:
>>>>
>>>>> Hi there -
>>>>>
>>>>>
>>>>> In my JavaScript file, is there a javadoc tag I can use to set off
>>>>> a small, illustrative code snippet? Is there anything like an
>>>>> @example tag I can put in front of the code snippet to set the
>>>>> sample code apart from the function description? Also, bordering
>>>>> the code sample do I need to have <code></code> tags so that the
>>>>> text will appear in code format?
>>>>>
>>>>>
>>>>> For example:
>>>>>
>>>>>
>>>>> /**Initializes a new record and returns an nlobjRecord containing
>>>>> all the default field data for that record type
>>>>>
>>>>> *@param type  record type for the record
>>>>>
>>>>> *@example the following example initializes a new opportunity
>>>>> record
>>>>>
>>>>> *<code>var record = nlapiCreateRecord('opportunity')</code>
>>>>>
>>>>> *<code>var defaultstatus = record.getFieldValue('entitystatus')</
>>>>> code>
>>>>>
>>>>> */
>>>>>
>>>>> function nlapiCreateRecord(type) { ; }
>>>>>
>>>>>
>>>>>
>>>>> Many of the developers around here like the output of JSDoc, but
>>>>> they want the output to capture a lot of things I just don't know
>>>>> how to add yet, like code samples imbedded/commented within the
>>>>> code.
>>>>>
>>>>>
>>>>> Thanks!
>>>>>
>>>>> kate
>>>>>
>>>>> ------------------------------------------------------------------ 
>>>>> -
>
>>>>> --
>>>>> ----
>>>>> Take Surveys. Earn Cash. Influence the Future of IT
>>>>> Join SourceForge.net's Techsay panel and you'll get the chance to
>>>>> share your
>>>>> opinions on IT & business topics through brief surveys-and earn
>>>>> cash
>>>>> http://www.techsay.com/default.php?
>>>>> page=join.php&p=sourceforge&CID=DEVDEV____________________________ 
>>>>> _
>
>>>>> __
>>>>> ________________
>>>>> Jsdoc-user mailing list
>>>>> Jsd...@li...
>>>>> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>>>>
>>>
>>>
>>> -------------------------------------------------------------------- 
>>> -
>
>>> ----
>>> Take Surveys. Earn Cash. Influence the Future of IT
>>> Join SourceForge.net's Techsay panel and you'll get the chance to
>>> share your
>>> opinions on IT & business topics through brief surveys-and earn cash
>>> http://www.techsay.com/default.php?
>>> page=join.php&p=sourceforge&CID=DEVDEV
>>> _______________________________________________
>>> Jsdoc-user mailing list
>>> Jsd...@li...
>>> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>>
>>
>>
>> --------------------------------------------------------------------- 
>> -
>
>> ---
>> Take Surveys. Earn Cash. Influence the Future of IT
>> Join SourceForge.net's Techsay panel and you'll get the chance to
>> share your
>> opinions on IT & business topics through brief surveys-and earn cash
>> http://www.techsay.com/default.php?
>> page=join.php&p=sourceforge&CID=DEVDEV
>> _______________________________________________
>> Jsdoc-user mailing list
>> Jsd...@li...
>> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>

Re: [Jsdoc-user] Fwd: adding code sample/snippet to jsdoc

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

Wait? Absolutely not! Don't wait. Join the JSDoc-2 group right now  
and perhaps give us a hand with the work! :-)

Seriously though I've been playing with jsdoc-2 for months now and  
would consider it quite usable already. I'm probably a little biased  
in that regard but that's why I need folks like yourself to take a  
look and share their feedback.

I look forward to seeing you in the group! http://code.google.com/p/ 
jsdoc-2/

Regards,
Michael


On 2 Mar 2007, at 21:02, Rodrigues, Kate wrote:

> My knowledge of perl is next to nothing. Should I wait for JSDoc-2  
> to be released rather than try to figure out how to add a custom  
> @example tag to the current JSDoc-1 config file?
>
> thanks!
> kate
>
> ________________________________
>
> From: Gabriel Reid [mailto:gab...@gm...]
> Sent: Fri 3/2/2007 12:28 PM
> To: jsd...@li...
> Cc: Rodrigues, Kate
> Subject: Re: [Jsdoc-user] Fwd: adding code sample/snippet to jsdoc
>
>
>
> Hi,
>
> As Michael pointed out, JSDoc-2 has much stronger support for custom
> constructs such as this one. However, JSDoc 1 also has very basic
> support for this as well, in the not-very-well-known .jsdoc_config  
> file.
> Adding support for new tags *does* require that you have at least a  
> basic
> understanding of perl, as this configuration file consists of perl
> callbacks for custom tags.
>
> On the other hand, of course, you could simply put the example code
> inside of <code> tags, which might just be sufficient.
>
> Regards,
>
>     Gabriel
>
>
> On Fri, Mar 02, 2007 at 07:40:07AM +0000, Michael Mathews wrote:
>> Hi,
>>
>> Gabriel can answer for JSDoc 1.x but because JSDoc-2 doesn't pick and
>> choose which tags it will process, you very well could invent an
>> @example tag. In that case the example text would be passed into the
>> template as-is.
>>
>> If your template produced HTML, then there is nothing to stop you
>> from having any HTML tags you wanted in the body of your example tag.
>> In JSDoc-2 your tag could look like this:
>>
>> /**
>> nlapiCreateRecord - Initializes a new record and returns an
>> nlobjRecord containing all the default field data for that record  
>> type
>> @param type - record type for the record
>> @example The following example initializes a new opportunity record.
>> <code>
>> var record = nlapiCreateRecord('opportunity')
>> var defaultstatus = record.getFieldValue('entitystatus')
>> </code>
>> */
>> function nlapiCreateRecord(type) { ; }
>>
>> But we are still developing JSDoc-2. When the first beta is released
>> (any day now!) I'll include an example of how to write a template to
>> handle example tags.
>>
>> Regards,
>> Michael
>>>
>>> On 1 Mar 2007, at 23:07, Rodrigues, Kate wrote:
>>>
>>>> Hi there -
>>>>
>>>>
>>>> In my JavaScript file, is there a javadoc tag I can use to set off
>>>> a small, illustrative code snippet? Is there anything like an
>>>> @example tag I can put in front of the code snippet to set the
>>>> sample code apart from the function description? Also, bordering
>>>> the code sample do I need to have <code></code> tags so that the
>>>> text will appear in code format?
>>>>
>>>>
>>>> For example:
>>>>
>>>>
>>>> /**Initializes a new record and returns an nlobjRecord containing
>>>> all the default field data for that record type
>>>>
>>>> *@param type  record type for the record
>>>>
>>>> *@example the following example initializes a new opportunity  
>>>> record
>>>>
>>>> *<code>var record = nlapiCreateRecord('opportunity')</code>
>>>>
>>>> *<code>var defaultstatus = record.getFieldValue('entitystatus')</
>>>> code>
>>>>
>>>> */
>>>>
>>>> function nlapiCreateRecord(type) { ; }
>>>>
>>>>
>>>>
>>>> Many of the developers around here like the output of JSDoc, but
>>>> they want the output to capture a lot of things I just don't know
>>>> how to add yet, like code samples imbedded/commented within the  
>>>> code.
>>>>
>>>>
>>>> Thanks!
>>>>
>>>> kate
>>>>
>>>> ------------------------------------------------------------------- 
>>>> --
>>>> ----
>>>> Take Surveys. Earn Cash. Influence the Future of IT
>>>> Join SourceForge.net's Techsay panel and you'll get the chance to
>>>> share your
>>>> opinions on IT & business topics through brief surveys-and earn  
>>>> cash
>>>> http://www.techsay.com/default.php?
>>>> page=join.php&p=sourceforge&CID=DEVDEV_____________________________ 
>>>> __
>>>> ________________
>>>> Jsdoc-user mailing list
>>>> Jsd...@li...
>>>> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>>>
>>
>>
>> --------------------------------------------------------------------- 
>> ----
>> Take Surveys. Earn Cash. Influence the Future of IT
>> Join SourceForge.net's Techsay panel and you'll get the chance to  
>> share your
>> opinions on IT & business topics through brief surveys-and earn cash
>> http://www.techsay.com/default.php? 
>> page=join.php&p=sourceforge&CID=DEVDEV
>> _______________________________________________
>> Jsdoc-user mailing list
>> Jsd...@li...
>> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>
>
>
> ---------------------------------------------------------------------- 
> ---
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to  
> share your
> opinions on IT & business topics through brief surveys-and earn cash
> http://www.techsay.com/default.php? 
> page=join.php&p=sourceforge&CID=DEVDEV
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user

Re: [Jsdoc-user] Fwd: adding code sample/snippet to jsdoc

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

Hi Kate,

Yes, I'd say that that's the path of least resistance then.


Gabriel


On Fri, Mar 02, 2007 at 01:02:25PM -0800, Rodrigues, Kate wrote:
> My knowledge of perl is next to nothing. Should I wait for JSDoc-2 to be released rather than try to figure out how to add a custom @example tag to the current JSDoc-1 config file?
>  
> thanks!
> kate
> 
> ________________________________
> 
> From: Gabriel Reid [mailto:gab...@gm...]
> Sent: Fri 3/2/2007 12:28 PM
> To: jsd...@li...
> Cc: Rodrigues, Kate
> Subject: Re: [Jsdoc-user] Fwd: adding code sample/snippet to jsdoc
> 
> 
> 
> Hi,
> 
> As Michael pointed out, JSDoc-2 has much stronger support for custom
> constructs such as this one. However, JSDoc 1 also has very basic
> support for this as well, in the not-very-well-known .jsdoc_config file.
> Adding support for new tags *does* require that you have at least a basic
> understanding of perl, as this configuration file consists of perl
> callbacks for custom tags.
> 
> On the other hand, of course, you could simply put the example code
> inside of <code> tags, which might just be sufficient.
> 
> Regards,
> 
>     Gabriel
> 
> 
> On Fri, Mar 02, 2007 at 07:40:07AM +0000, Michael Mathews wrote:
> > Hi,
> >
> > Gabriel can answer for JSDoc 1.x but because JSDoc-2 doesn't pick and 
> > choose which tags it will process, you very well could invent an 
> > @example tag. In that case the example text would be passed into the 
> > template as-is.
> >
> > If your template produced HTML, then there is nothing to stop you 
> > from having any HTML tags you wanted in the body of your example tag. 
> > In JSDoc-2 your tag could look like this:
> >
> > /**
> > nlapiCreateRecord - Initializes a new record and returns an
> > nlobjRecord containing all the default field data for that record type
> > @param type - record type for the record
> > @example The following example initializes a new opportunity record.
> > <code>
> > var record = nlapiCreateRecord('opportunity')
> > var defaultstatus = record.getFieldValue('entitystatus')
> > </code>
> > */
> > function nlapiCreateRecord(type) { ; }
> >
> > But we are still developing JSDoc-2. When the first beta is released 
> > (any day now!) I'll include an example of how to write a template to 
> > handle example tags.
> >
> > Regards,
> > Michael
> > >
> > > On 1 Mar 2007, at 23:07, Rodrigues, Kate wrote:
> > >
> > >> Hi there -
> > >>
> > >>
> > >> In my JavaScript file, is there a javadoc tag I can use to set off 
> > >> a small, illustrative code snippet? Is there anything like an 
> > >> @example tag I can put in front of the code snippet to set the 
> > >> sample code apart from the function description? Also, bordering 
> > >> the code sample do I need to have <code></code> tags so that the 
> > >> text will appear in code format?
> > >>
> > >>
> > >> For example:
> > >>
> > >>
> > >> /**Initializes a new record and returns an nlobjRecord containing 
> > >> all the default field data for that record type
> > >>
> > >> *@param type  record type for the record
> > >>
> > >> *@example the following example initializes a new opportunity record
> > >>
> > >> *<code>var record = nlapiCreateRecord('opportunity')</code>
> > >>
> > >> *<code>var defaultstatus = record.getFieldValue('entitystatus')</
> > >> code>
> > >>
> > >> */
> > >>
> > >> function nlapiCreateRecord(type) { ; }
> > >>
> > >>
> > >>
> > >> Many of the developers around here like the output of JSDoc, but 
> > >> they want the output to capture a lot of things I just don't know 
> > >> how to add yet, like code samples imbedded/commented within the code.
> > >>
> > >>
> > >> Thanks!
> > >>
> > >> kate
> > >>
> > >> ---------------------------------------------------------------------
> > >> ----
> > >> Take Surveys. Earn Cash. Influence the Future of IT
> > >> Join SourceForge.net's Techsay panel and you'll get the chance to 
> > >> share your
> > >> opinions on IT & business topics through brief surveys-and earn cash
> > >> http://www.techsay.com/default.php?
> > >> page=join.php&p=sourceforge&CID=DEVDEV_______________________________
> > >> ________________
> > >> Jsdoc-user mailing list
> > >> Jsd...@li...
> > >> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
> > >
> >
> >
> > -------------------------------------------------------------------------
> > Take Surveys. Earn Cash. Influence the Future of IT
> > Join SourceForge.net's Techsay panel and you'll get the chance to share your
> > opinions on IT & business topics through brief surveys-and earn cash
> > http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
> > _______________________________________________
> > Jsdoc-user mailing list
> > Jsd...@li...
> > https://lists.sourceforge.net/lists/listinfo/jsdoc-user
> 
> 

Re: [Jsdoc-user] Fwd: adding code sample/snippet to jsdoc

[Rodrigues, K. <kro...@ne...>]

My knowledge of perl is next to nothing. Should I wait for JSDoc-2 to be =
released rather than try to figure out how to add a custom @example tag =
to the current JSDoc-1 config file?
=20
thanks!
kate

________________________________

From: Gabriel Reid [mailto:gab...@gm...]
Sent: Fri 3/2/2007 12:28 PM
To: jsd...@li...
Cc: Rodrigues, Kate
Subject: Re: [Jsdoc-user] Fwd: adding code sample/snippet to jsdoc



Hi,

As Michael pointed out, JSDoc-2 has much stronger support for custom
constructs such as this one. However, JSDoc 1 also has very basic
support for this as well, in the not-very-well-known .jsdoc_config file.
Adding support for new tags *does* require that you have at least a =
basic
understanding of perl, as this configuration file consists of perl
callbacks for custom tags.

On the other hand, of course, you could simply put the example code
inside of <code> tags, which might just be sufficient.

Regards,

    Gabriel


On Fri, Mar 02, 2007 at 07:40:07AM +0000, Michael Mathews wrote:
> Hi,
>
> Gabriel can answer for JSDoc 1.x but because JSDoc-2 doesn't pick and=20
> choose which tags it will process, you very well could invent an=20
> @example tag. In that case the example text would be passed into the=20
> template as-is.
>
> If your template produced HTML, then there is nothing to stop you=20
> from having any HTML tags you wanted in the body of your example tag.=20
> In JSDoc-2 your tag could look like this:
>
> /**
> nlapiCreateRecord - Initializes a new record and returns an
> nlobjRecord containing all the default field data for that record type
> @param type - record type for the record
> @example The following example initializes a new opportunity record.
> <code>
> var record =3D nlapiCreateRecord('opportunity')
> var defaultstatus =3D record.getFieldValue('entitystatus')
> </code>
> */
> function nlapiCreateRecord(type) { ; }
>
> But we are still developing JSDoc-2. When the first beta is released=20
> (any day now!) I'll include an example of how to write a template to=20
> handle example tags.
>
> Regards,
> Michael
> >
> > On 1 Mar 2007, at 23:07, Rodrigues, Kate wrote:
> >
> >> Hi there -
> >>
> >>
> >> In my JavaScript file, is there a javadoc tag I can use to set off=20
> >> a small, illustrative code snippet? Is there anything like an=20
> >> @example tag I can put in front of the code snippet to set the=20
> >> sample code apart from the function description? Also, bordering=20
> >> the code sample do I need to have <code></code> tags so that the=20
> >> text will appear in code format?
> >>
> >>
> >> For example:
> >>
> >>
> >> /**Initializes a new record and returns an nlobjRecord containing=20
> >> all the default field data for that record type
> >>
> >> *@param type  record type for the record
> >>
> >> *@example the following example initializes a new opportunity =
record
> >>
> >> *<code>var record =3D nlapiCreateRecord('opportunity')</code>
> >>
> >> *<code>var defaultstatus =3D record.getFieldValue('entitystatus')</
> >> code>
> >>
> >> */
> >>
> >> function nlapiCreateRecord(type) { ; }
> >>
> >>
> >>
> >> Many of the developers around here like the output of JSDoc, but=20
> >> they want the output to capture a lot of things I just don't know=20
> >> how to add yet, like code samples imbedded/commented within the =
code.
> >>
> >>
> >> Thanks!
> >>
> >> kate
> >>
> >> =
---------------------------------------------------------------------
> >> ----
> >> Take Surveys. Earn Cash. Influence the Future of IT
> >> Join SourceForge.net's Techsay panel and you'll get the chance to=20
> >> share your
> >> opinions on IT & business topics through brief surveys-and earn =
cash
> >> http://www.techsay.com/default.php?
> >> =
page=3Djoin.php&p=3Dsourceforge&CID=3DDEVDEV_____________________________=
__
> >> ________________
> >> Jsdoc-user mailing list
> >> Jsd...@li...
> >> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
> >
>
>
> =
-------------------------------------------------------------------------=

> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to =
share your
> opinions on IT & business topics through brief surveys-and earn cash
> =
http://www.techsay.com/default.php?page=3Djoin.php&p=3Dsourceforge&CID=3D=
DEVDEV
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user

Re: [Jsdoc-user] Fwd: adding code sample/snippet to jsdoc

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

Hi,

As Michael pointed out, JSDoc-2 has much stronger support for custom 
constructs such as this one. However, JSDoc 1 also has very basic
support for this as well, in the not-very-well-known .jsdoc_config file.
Adding support for new tags *does* require that you have at least a basic
understanding of perl, as this configuration file consists of perl 
callbacks for custom tags.

On the other hand, of course, you could simply put the example code
inside of <code> tags, which might just be sufficient.

Regards,

    Gabriel


On Fri, Mar 02, 2007 at 07:40:07AM +0000, Michael Mathews wrote:
> Hi,
> 
> Gabriel can answer for JSDoc 1.x but because JSDoc-2 doesn't pick and  
> choose which tags it will process, you very well could invent an  
> @example tag. In that case the example text would be passed into the  
> template as-is.
> 
> If your template produced HTML, then there is nothing to stop you  
> from having any HTML tags you wanted in the body of your example tag.  
> In JSDoc-2 your tag could look like this:
> 
> /**
> nlapiCreateRecord - Initializes a new record and returns an
> nlobjRecord containing all the default field data for that record type
> @param type - record type for the record
> @example The following example initializes a new opportunity record.
> <code>
> var record = nlapiCreateRecord('opportunity')
> var defaultstatus = record.getFieldValue('entitystatus')
> </code>
> */
> function nlapiCreateRecord(type) { ; }
> 
> But we are still developing JSDoc-2. When the first beta is released  
> (any day now!) I'll include an example of how to write a template to  
> handle example tags.
> 
> Regards,
> Michael
> >
> > On 1 Mar 2007, at 23:07, Rodrigues, Kate wrote:
> >
> >> Hi there –
> >>
> >>
> >> In my JavaScript file, is there a javadoc tag I can use to set off  
> >> a small, illustrative code snippet? Is there anything like an  
> >> @example tag I can put in front of the code snippet to set the  
> >> sample code apart from the function description? Also, bordering  
> >> the code sample do I need to have <code></code> tags so that the  
> >> text will appear in code format?
> >>
> >>
> >> For example:
> >>
> >>
> >> /**Initializes a new record and returns an nlobjRecord containing  
> >> all the default field data for that record type
> >>
> >> *@param type  record type for the record
> >>
> >> *@example the following example initializes a new opportunity record
> >>
> >> *<code>var record = nlapiCreateRecord('opportunity')</code>
> >>
> >> *<code>var defaultstatus = record.getFieldValue('entitystatus')</ 
> >> code>
> >>
> >> */
> >>
> >> function nlapiCreateRecord(type) { ; }
> >>
> >>
> >>
> >> Many of the developers around here like the output of JSDoc, but  
> >> they want the output to capture a lot of things I just don’t know  
> >> how to add yet, like code samples imbedded/commented within the code.
> >>
> >>
> >> Thanks!
> >>
> >> kate
> >>
> >> --------------------------------------------------------------------- 
> >> ----
> >> Take Surveys. Earn Cash. Influence the Future of IT
> >> Join SourceForge.net's Techsay panel and you'll get the chance to  
> >> share your
> >> opinions on IT & business topics through brief surveys-and earn cash
> >> http://www.techsay.com/default.php? 
> >> page=join.php&p=sourceforge&CID=DEVDEV_______________________________ 
> >> ________________
> >> Jsdoc-user mailing list
> >> Jsd...@li...
> >> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
> >
> 
> 
> -------------------------------------------------------------------------
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to share your
> opinions on IT & business topics through brief surveys-and earn cash
> http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user

Re: [Jsdoc-user] Globalization

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

Hi J=FAlio,

You might be interested to know that I have tried a wide range of =20
UTF8 characters in a test case of JSDoc-2. In FireFox, as HTML, it =20
displayed perfectly.

Watch for the beta release of JSDoc-2 in the next few days.

Regards,
Michael

On 2 Mar 2007, at 12:42, J=FAlio C=E9sar K=F6del wrote:

> JS-Doc does not seem to accept portuguese characters with accents,
> specially if they are saved in Unicode (as =E1, =C3, =E7, etc...)
>
> Here a sample:
>
> =EF=BB=BF/*####################
>  Vari=C3=A1veis globais
> #######################*/
>
> Where =EF=BB=BF is the common header for UTF-8 files saved by =
Microsoft
> Visual Studio 2005.
> The "Vari=C3=A1veis" should be "Vari=E1veis"
>
> --=20
> []
> J=FAlio C=E9sar K=F6del G.
>
> ----------------------------------------------------------------------=20=

> ---
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to =20
> share your
> opinions on IT & business topics through brief surveys-and earn cash
> http://www.techsay.com/default.php?=20
> page=3Djoin.php&p=3Dsourceforge&CID=3DDEVDEV
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user

[Jsdoc-user] Globalization

[<jc...@gm...>]

JS-Doc does not seem to accept portuguese characters with accents,
specially if they are saved in Unicode (as =E1, =C3, =E7, etc...)

Here a sample:

=EF=BB=BF/*####################
 Vari=C3=A1veis globais
#######################*/

Where =EF=BB=BF is the common header for UTF-8 files saved by Microsoft
Visual Studio 2005.
The "Vari=C3=A1veis" should be "Vari=E1veis"

--=20
[]
J=FAlio C=E9sar K=F6del G.

[Jsdoc-user] Fwd: adding code sample/snippet to jsdoc

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

Hi,

Gabriel can answer for JSDoc 1.x but because JSDoc-2 doesn't pick and =20=

choose which tags it will process, you very well could invent an =20
@example tag. In that case the example text would be passed into the =20
template as-is.

If your template produced HTML, then there is nothing to stop you =20
from having any HTML tags you wanted in the body of your example tag. =20=

In JSDoc-2 your tag could look like this:

/**
nlapiCreateRecord - Initializes a new record and returns an
nlobjRecord containing all the default field data for that record type
@param type - record type for the record
@example The following example initializes a new opportunity record.
<code>
var record =3D nlapiCreateRecord('opportunity')
var defaultstatus =3D record.getFieldValue('entitystatus')
</code>
*/
function nlapiCreateRecord(type) { ; }

But we are still developing JSDoc-2. When the first beta is released =20
(any day now!) I'll include an example of how to write a template to =20
handle example tags.

Regards,
Michael
>
> On 1 Mar 2007, at 23:07, Rodrigues, Kate wrote:
>
>> Hi there =96
>>
>>
>> In my JavaScript file, is there a javadoc tag I can use to set off =20=

>> a small, illustrative code snippet? Is there anything like an =20
>> @example tag I can put in front of the code snippet to set the =20
>> sample code apart from the function description? Also, bordering =20
>> the code sample do I need to have <code></code> tags so that the =20
>> text will appear in code format?
>>
>>
>> For example:
>>
>>
>> /**Initializes a new record and returns an nlobjRecord containing =20
>> all the default field data for that record type
>>
>> *@param type  record type for the record
>>
>> *@example the following example initializes a new opportunity record
>>
>> *<code>var record =3D nlapiCreateRecord('opportunity')</code>
>>
>> *<code>var defaultstatus =3D record.getFieldValue('entitystatus')</=20=

>> code>
>>
>> */
>>
>> function nlapiCreateRecord(type) { ; }
>>
>>
>>
>> Many of the developers around here like the output of JSDoc, but =20
>> they want the output to capture a lot of things I just don=92t know =20=

>> how to add yet, like code samples imbedded/commented within the code.
>>
>>
>> Thanks!
>>
>> kate
>>
>> ---------------------------------------------------------------------=20=

>> ----
>> Take Surveys. Earn Cash. Influence the Future of IT
>> Join SourceForge.net's Techsay panel and you'll get the chance to =20
>> share your
>> opinions on IT & business topics through brief surveys-and earn cash
>> http://www.techsay.com/default.php?=20
>> page=3Djoin.php&p=3Dsourceforge&CID=3DDEVDEV___________________________=
____=20
>> ________________
>> Jsdoc-user mailing list
>> Jsd...@li...
>> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>

[Jsdoc-user] adding code sample/snippet to jsdoc

[Rodrigues, K. <kro...@ne...>]

Hi there -

=20

In my JavaScript file, is there a javadoc tag I can use to set off a
small, illustrative code snippet? Is there anything like an @example tag
I can put in front of the code snippet to set the sample code apart from
the function description? Also, bordering the code sample do I need to
have <code></code> tags so that the text will appear in code format?

=20

For example:

=20

/**Initializes a new record and returns an nlobjRecord containing all
the default field data for that record type

*@param type  record type for the record

*@example the following example initializes a new opportunity record

*<code>var record =3D nlapiCreateRecord('opportunity')</code>

*<code>var defaultstatus =3D record.getFieldValue('entitystatus')</code>

*/

function nlapiCreateRecord(type) { ; }   =20

=20

=20

Many of the developers around here like the output of JSDoc, but they
want the output to capture a lot of things I just don't know how to add
yet, like code samples imbedded/commented within the code.=20

=20

Thanks!

kate

Re: [Jsdoc-user] Comments on variables

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

Hi J=FAlio,

You might be interested in looking at the JSDoc-2 project. Your =20
request would be possible using JSDoc-2 by simply adding the =20
following comment...

/**
  * MyGlobalVariable - A description of this variable.
  */
var MyGlobalVariable =3D new Array();

The only catch is that JSDoc-2 is still in development. The first =20
beta release is imminent; perhaps you will help us with the testing?

Regards,
Michael


On 25 Feb 2007, at 14:13, Gabriel Reid wrote:

> Hi,
>
> On Wed, Feb 21, 2007 at 07:15:22PM -0200, J=FAlio C=E9sar K=F6del =
wrote:
>> Is there some way to document our global variables?
>> For example:
>>
>> var MyGlobalVariable =3D new Array();
>>
>> I would like to have a description of some key variables in my =20
>> project.
>
> No, this isn't currently possible with JSDoc.
>
> Regards,
>
>     Gabriel
>
> ----------------------------------------------------------------------=20=

> ---
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to =20
> share your
> opinions on IT & business topics through brief surveys-and earn cash
> http://www.techsay.com/default.php?=20
> page=3Djoin.php&p=3Dsourceforge&CID=3DDEVDEV
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user

Re: [Jsdoc-user] Comments on variables

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

Hi, 

On Wed, Feb 21, 2007 at 07:15:22PM -0200, Júlio César Ködel wrote:
> Is there some way to document our global variables?
> For example:
> 
> var MyGlobalVariable = new Array();
> 
> I would like to have a description of some key variables in my project.

No, this isn't currently possible with JSDoc.

Regards,

    Gabriel

[Jsdoc-user] Comments on variables

[<jc...@gm...>]

Hello there!

Is there some way to document our global variables?
For example:

var MyGlobalVariable =3D new Array();

I would like to have a description of some key variables in my project.

Thanx in advance

--=20
[]
J=FAlio C=E9sar K=F6del G.

[Jsdoc-user] Bruce Wallace is out of town.

[<bru...@wa...>]

I will be out of the office starting  10/27/2006 and will not return until
11/02/2006.

I will respond to your message when I return.

[Jsdoc-user] Unobtrusive Javascript Framework by Tennaxia

[christophe b. <cb...@te...>]

Hi,

I'd like to inform you that we are currently building a javascript
framework for unobtrusive usage.

You can find informations here : https://www.tennaxia.net/tos_trac

The frameworks is built around components :
    - common : basic fucntionnalities
    - datagrid : enhance a HTML table that displays data
    - forms : various enhancements to HTML form elements
    - layout : various enhancements to HTML presentation

The framework is mainly based on Prototype, Scriptaculous and
event:Selector, but also on some scripts coming from the internet.

As you may own copyright on some of these scripts, we'd like to invite
you to verify that we did not break any IP rights.
If we did so (I hope we did not but ...), please provide us with
directions to correct our mistake.

Also, we'd like to invite you to participate in the project.
The advantages to participate in the project are numerous :
1/ we provide the Trac system so you have tickets, wiki, forums, SVN,
... for free
2/ you can benefit from tested scripts with a consistent organization
3/ the component architecture allows you to use only what you want to
use : all the components of the framework work without the others BUT
they can work together.

If you want to participate, simply answer back to this mail : I'll do
the necessary to provide you more informations to create an account on
the Trac system and on the SVN.

I hope you will visit the UJF site and talk about it on your blog, so
the project can gain popularity quickly.

Best regards,

Christophe Blin
Tennaxia

-- 

_____________________________________________________________________
Tennaxia, www.tennaxia.com,
Pilotez vos obligations environnementales
_____________________________________________________________________
Siège social :
6, rue Léonard de Vinci - 53001 Laval Cedex -
Tél : 02 43 49 75 50 - Fax : 02 43 49 75 77
Agence Paris :
19, rue réaumur - 75003 Paris -
Tél : 01 42 77 04 19 - Fax : 08 25 19 19 61
Agence Lyon :
Parc du Chater - 63 rue de la garenne - 69340 FRANCHEVILLE -
Tél : 04 72 39 98 14 - Fax : 04 72 39 93 85
The information in this message sent by TENNAXIA is confidential 
and may be legally privileged. It is intended solely for the 
addressee(s). Access to this message by anyone else is unauthorized.
If you are not the intended recipient, please delete it and notify 
the sender : any disclosure, copying, distribution or any action 
taken or omitted to be taken in reliance on it, is prohibited and 
may be unlawful.

[Jsdoc-user] Does JSDoc supports Multiple Inheritence?

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

Hi Everyone,

Does JSDoc support Multiple Inheritence? If it is yes, could you please
provide me with sample script file and the documentation tags.

Thanks & Regards,
Jagadesh

[Jsdoc-user] Is differentiation of methods possible with JSDoc?

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

Hi Everyone,

Is it possible to differntiate methods in JSDoc?
I want to differentiate the method types like (event,property, association,
behaviour).

If any one knows please reply me as soon as possible.

Thanks and Regards,
Jagadesh

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

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

Hi Cameron,

Head over to the google group (the JSDoc2 discussion has become split
unfortunately, but it belongs in the google group).

http://groups.google.com/group/jsdoc-2

There's a thread started already called "What Language?"

Thanks for your interest, read what's already been posted and then you can
repost this there if you still want to.

Regards,
Michael

On 18/10/06, Cameron Shorter <cam...@gm...> wrote:
>
> What language are you planning to write jsdoc2 in?
>
> One of our problems with JSDoc is that it is written in perl, and is
> difficult for windows developers to set up, and difficult to integrate
> with java build scripts. (For http://communitymapbuilder.org we use ant).
>
> My criteria for the language is it needs to be easy to install, and
> preferably already installed, wherever the JS is being developed
> (windows, linux, mac etc).
>
> 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
> >
>
>
> --
> Cameron Shorter
> http://cameron.shorter.net
>
> -------------------------------------------------------------------------
> 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!]

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

What language are you planning to write jsdoc2 in?

One of our problems with JSDoc is that it is written in perl, and is 
difficult for windows developers to set up, and difficult to integrate 
with java build scripts. (For http://communitymapbuilder.org we use ant).

My criteria for the language is it needs to be easy to install, and 
preferably already installed, wherever the JS is being developed 
(windows, linux, mac etc).

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
> 


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