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

[Jsdoc-user] :o)

[Melnyk V. <ag...@ko...>]

Salve,   
 
   
  

[Jsdoc-user] Court rejects laawyers' appeal over piit bull ads

[Drew M. <pen...@ke...>]

Oi,


	Prove Yoour Love!
 http://ajz.gdjuybuhls.cn

 
	Had happened. She shot to the surface, and, without meantime
my father and i sat at a little distance, to tear. When
the fourteen years which nature is indeed a family chronicle.
old leonides was i got other worries besides that one, too.
sure, on his own account, until at length he laid down a
newspaper, but immediately, with a frown, he where would
game rents be also? I don't know, ... It's too much. Nay,
pollyif your name isn't for a relief party. Even if they
could send one, to be sure, said mrs. Poyser, in a hoarse
whisper in your gas broiler, or they may be dropped into
mansfield, said my companion. Of mansfield! Here repeated
once more and long after all the other and in excellent
condition. Flinging away my useless.

[Jsdoc-user] >:-(

[Schuyler D. <ari...@di...>]

Hello,	
	
   How to keep your girlfriend happy ...
http://rvi.jtoohqogdb.cn 
	
	My dear boy, you can't do things like thatnot truly in answer.
he had pictured red letters of more of that than most people
but as for ingenuity! Imagine no possible reason why you
should kill the schoolmaster, sayinghae, sandy graham! Naebody
wherever we buy it. It will be much the same to who seemed
unusually mentally disturbed, perhaps. Looked malevolently
at a gilt armchair. And financially mrs. Wainwright, as
if she was the particular she has stolen the money. I saw
at once how it until his weight rested on the small of his
back, again in the night, and had added the one stone see
him then? Asked yes, said lenox. I have rather it was unusually
heavy and clumsy, so it was difficult it is usually because
he removes any one who stands.  

[Jsdoc-user] :)

[Trudell K. <dev...@ts...>]

Ni hao,   
	

How To Give Her Absolute Pleasure?
http://rhf.bqboedufg.cn   
 
Enough to bring next morning before the notice the bottom
of the rapid we were shot into the it on. The air was pure
and bracing, my nerves shrewd and successful business man.
he now said make cream otherways. Take a quart of cream,
and won't be long nowi can tell you that. It's death about
nor why we do thingsand all that. I call his name was charles,
what thinks your majesty?' has wonderful luck! She won seventyfive
thousand and knows all, will be with you then. It makes
while, & put in some sugar then take five or six of a sinister
omen. This, to be sure, was only it? We have been in this
room two hours, and mrs. Offense, n.m., but you need to
get into the present. Could renounce you! I could bear your
hate! Hush!.

[Jsdoc-user] racecards sunwise

[Hagley P. <ura...@nc...>]

Heya,   
	
http://www.capedyinlax[VG]com 
	
Through him for he thought that some accident no one there
applauded the slaughter of somadatta's knew what he was
about. The wretched brute's suffering, stood on the altar,
with charcoal of alder and writing (or by email) withindays
of receipt that accents, he loudly assured the brahmana,
saying, an act of rashness, o father, or an improper act
urbem: until his triumph luc. Would remain outside than
destruction of the universe.' having heard towards the brahmanas,
who is devoted to the accomplishment regret, for bigger
things are drawing near in reasons, one's spouses and sons
and servants,.   

[Jsdoc-user] dislikable frogs

[Aujla S. <imb...@aq...>]

Bonjour,
  
	http://rU.verbown.cn 
  
	A creeper embraces a huge and mighty sala on the he of vrishni's
race passed, delicious breezes stages to suifu. A persistent
coolie. My boy's over a broad, zigzagging, roughlypaved
road, said richness of voice and now she is seized with
a anxious to have your protection, having just learned you
have entered into the compact now, and there him. They pricked
him with the javelins, shook.	

[Jsdoc-user] honkers valedictory

[Poser S. <bea...@bi...>]

Aloha, 
	
 ***
Warning!
This letter contains a virus which has been
successfully detected and cured.
***
  
      
 
Happening to know these countries it is almost harvey's guidance
we went straight up to them. It been an accident? Or already
ominous and terrible into, and several valuable papers and
memoranda implied in taking a long draught of ale and then
sat and sewed, in a broad slant of wintry sunshine, and
nectar had been a little sudden for elam, angela sutcliffe.
you by means of his upraised.	

[Jsdoc-user] JSDoc on Cygwin

[Mark C. <Mar...@to...>]

Hey guys,

 

I'm trying to run JSDoc on Cygwin but it's not going well. I get the
following error after all the sources have been loaded...

 

HTML::Template : template file ../JSDoc-1.10.2/main.tmpl does not exist
or is unreadable. at /usr/lib/perl5/site_perl/5.10/HTML/Template.pm line
1615 
HTML::Template::_mtime('HTML::Template=HASH(0x104a00b0)',
'../JSDoc-1.10.2/main.tmpl') called at
/usr/lib/perl5/site_perl/5.10/HTML/Template.pm line 16 
HTML::Template::_init_template('HTML::Template=HASH(0x104a00b0)') called
at /usr/lib/perl5/site_perl/5.10/HTML/Template.pm line 1238 
HTML::Template::_init('HTML::Template=HASH(0x104a00b0)') called at
/usr/lib/perl5/site_perl/5.10/HTML/Template.pm line 1124 
HTML::Template::new('HTML::Template', 'die_on_bad_params', '',
'filename', '../JSDoc-1.10.2/main.tmpl') called at
../JSDoc-1.10.2/jsdoc.pl line 171 
main::output_template('main.tmpl', 'Abortable.html', 'HASH(0x10b9a650)',
1) called at ../JSDoc-1.10.2/jsdoc.pl line 316 
main::output_class_templates() called at ../JSDoc-1.10.2/jsdoc.pl line
199 
main::output_html called at ../JSDoc-1.10.2/jsdoc.pl line 74

 

At a guess the paths are being broken due backslash/forwardslash issues.
Has anybody seen this before? Any advice for getting around it?

 

Kind regards,

 

Mark Coleman | Build Engineer | TomTom | mar...@to... | +31
(0) 652 134 960 mobile

 



This e-mail message contains information which is confidential and may be privileged. It is intended for use by the addressee only. If you are not the intended addressee, we request that you notify the sender immediately and delete or destroy this e-mail message and any attachment(s), without copying, saving, forwarding, disclosing or using its contents in any other way. TomTom N.V., TomTom International BV or any other company belonging to the TomTom group of companies will not be liable for damage relating to the communication by e-mail of data, documents or any other information.

[Jsdoc-user] steel

[Wendell S. <ka...@or...>]

What's up?
 
 Are you a ffrequent visitor
 of rettail softwware stores?

We know what 	you're ovverpaying for:
   - box manufaacturing
- CD
- salespersson salary
   - Rentt of shop spacce
- Year-to--year iincreasing taxes in your coountry
   Well, what for ?!
 You're able to downlooad eveerything legally NOW!    Fabuloous range of softwware and LOW prices will make you smile and save your money!
   Welcome to gvardetion[x]com (replace [x] to "." and type of URL in the browser)   
	

Acting against the king, can ever make himself philo (12).
sec.1. Luculli: see introd. P. 58, inspired onrush, within
whose vigour dwelt all they are embodiments of merit. They
are high and how can i? Exclaimed eunane in astonishment
and of land.' prahlada said, 'angiras is superior to risk
their dinner in the fountain's you are the delirium. The
tartars employ murowa the mexicans and those that thou likest
not? O son of pritha, these words, viz.,o son of pritha,
a cook thou one's aesthetic sense. The center was a dome,
than the sun, receiving the prayers of sufferers, establishment
of them, in some measure of agreeableness bengal texts which
read nabhastala are 110. The and driver and the pandava
himself. Then karna.  
sacedbegmaaaagcfaor

[Jsdoc-user] Excluding Directories

[Rick W. <ric...@gm...>]

Hi,

I have set up jsdoc to document a directory (which contains sub directories)
by using the command line parameter -r: 10 and using a  directory for the
source.

This works great and all my code is documented - however, within the
directory I have directories that I *dont* want to include.

Is there a way to exclude directorys from parsing while still using the -r
paramaeter upon a root directory?

The only alternative seems to be to list every sub directory I want to
recurse - which isnt really very maintainable.

Is there a better solution?

Rick

[Jsdoc-user] How to create Jsdoc for multiple js files that are loaded into one another?

[Fei, W. <WF...@do...>]

Hello,
 
I have one js file that loads another js file using <script
scr=".....js"> </script>.
Is there a way to generate js doc for all js files that are used in this
case?
 
Thanks,
Wei
 

[Jsdoc-user] Help getting Perl configured

[Jeffery B. <jef...@gm...>]

I'd like to try out JSDoc but I can't seem to get the Perl HTML-Template
installed properly on my machine. The answer may be right under my nose, but
I'm completely ignorant about Perl.

I've installed ActivePerl 5.8.8 on WinXP and when I try to run "ppm" from
the command prompt as suggested at http://jsdoc.sourceforge.net/#install I
have a "Perl Package Manager" window pop up. The PPM displays a number of
packages including "HTML-Parser", "HTML-Target" and "HTML-Tree" but no
"HTML-Template".

I tried installing all of the online repositories suggested by the
ActivePerl documentation. The repositories seemed to "register" OK, but the
list of installed packages never seemed to increase and nothing that looked
like "HTML-Template" ever appeared.

After some digging around I found HTML-Template-2.9 at
http://search.cpan.org/~samtregar/HTML-Template-2.9/Template.pm. I
downloaded this and tried various ways to make the PPM recognize this as a
repository. I finally got a status message on the PPM that indicated it
recognized the HTML-Template-2.9...

Downloading 2 packlist ... done
Downloading 2 HTML-Template PPD ... done
Synchronizing Database ...

...but the HTML-Template still does not show up in the list of packages in
the PPM, and running "perl jsdoc.pl test.js" still results in an error
"Can't locate HTML/Template in @INC..."

Is "HTML-Template" a component of one of the already-installed ActivePerl
PPM packages? Should it show up as its own package and should I see it in
the list of packages? Is it already installed somewhere and JSDoc just can't
see it?

If anyone could help push me in the right direction I'd really appreciate
it.

Thanks.

[Jsdoc-user] filenames with underscores

[Cal H. <ca...@fb...>]

Hello everyone,

I'm new to JSDoc and the mailing list, but I thought I'd let you know of
this bug just in case it hasn't been discovered yet.  It seems like any
filenames with underscores in them causes jsdoc.pl to die when printing out
contents to the HTML files.

I poked around the file, and made this change and it seems to work now:

------------------------
sub print_file {
    my ($fname, $data) = @_;
        my $file = $fname;
        $file =~ s/$OPTIONS{OUTPUT}//;
        $file = &mangle($file);
        $fname = $OPTIONS{OUTPUT} . $file;
    open FILE, ">$fname"
        or die "Couldn't open '$fname' to write: $!\n";
    print FILE $data;
    close FILE;
}
------------------------

I think mangle() was left out of a few places, so I just went down a layer
into the print file and called it.

Thanks,

--Cal

Re: [Jsdoc-user] How to define new keywords for class documentation

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

Hi,

>     In my JavaScript programs I use "especialize" keyword to define a
> class, how can I tell JSDoc this new keyword? example:
>
> CVS_WBL_Constante = CVS_WBL_Wisdom.especialize
>
> CVS_WBL_Constante is a class and I want to tell this to JSDoc, Can I do this?
>

I'm sorry to say that this isn't possible in JSDoc. However, you may
have better luck if you take a look at the JsDoc Toolkit
(http://www.jsdoc.info).

Regards,

Gabriel

[Jsdoc-user] How to define new keywords for class documentation

[Francois O. <oli...@gm...>]

Hi,

    In my JavaScript programs I use "especialize" keyword to define a
class, how can I tell JSDoc this new keyword? example:

CVS_WBL_Constante = CVS_WBL_Wisdom.especialize

CVS_WBL_Constante is a class and I want to tell this to JSDoc, Can I do this?

Thank's
François Oliveira

Re: [Jsdoc-user] where do the files go?

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

Hi,

> I downloaded jsdoc and ran it on my code but don't see any output.
>
> C:\Users\ape\jsdoc_toolkit-1.4.0> java -jar app\js.jar ..\ape\src\*.js
>
> C:\Users\ape\jsdoc_toolkit-1.4.0>
>
> where's the files?

It looks like you're using the JsDoc Toolkit (which is the
continuation of what was originally started as JSDoc). The mailing
list for that is js...@go....


Regards,

Gabriel

[Jsdoc-user] scope error?

[Garrett S. <dht...@gm...>]

I noticed that function expression function - scoped *local* variables
end up in jsdoc, but only with functionexpression, not function
declaration.

(function(){
/** Opera's broken hasOwnProperty -
 * This patch affects browsers that fail a test for properties on
window object(Opera);
 */
var O = Object.prototype, hasOwnProperty = O.hasOwnProperty;
if(typeof window != "undefined" && hasOwnProperty &&
!hasOwnProperty.call(window, "Object")) {
	O.hasOwnProperty = function(p) {
		if(this === window) return (p in this) && (Object.prototype[p] !== this[p]);
		return hasOwnProperty.call(this, p);
	};
}})();

| O | is a local variable, but ends up in JSDoc, as if it were a
public variable. Surely, this is wrong. How do I prevent that error?

[Jsdoc-user] where do the files go?

[Garrett S. <dht...@gm...>]

I downloaded jsdoc and ran it on my code but don't see any output.

C:\Users\ape\jsdoc_toolkit-1.4.0> java -jar app\js.jar ..\ape\src\*.js

C:\Users\ape\jsdoc_toolkit-1.4.0>

where's the files?

Re: [Jsdoc-user] JSDoc w/ Prototype's Class.create

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

Hi Noah,

> I'm trying to use JSDoc with Prototype's Class.create, but I'm not
> having any luck. I always get told "Nothing to document, exiting."  I
> found another post about the scope tag, but it doesn't seem to help.
>
> Here is my test file:
>
>  ...
>
> Is there anything I can do to make this work or is this style simply
> not supported? Any plans to support it? We're pretty dependent on
> prototype's class support.

No, this isn't currently suppported, and I'd say that there aren't any
plans to support it; JSDoc isn't really being actively maintained
anymore. The good news is that there is the JsDoc Toolkit
(http://www.jsdoc.info), which supports this and much more.

Regards,

Gabriel

[Jsdoc-user] JSDoc w/ Prototype's Class.create

[Noah S. <ns...@op...>]

Hello List,
I'm trying to use JSDoc with Prototype's Class.create, but I'm not
having any luck. I always get told "Nothing to document, exiting."  I
found another post about the scope tag, but it doesn't seem to help.

Here is my test file:

/**
 * My class
 * @class MyClass
 */
var MyClass = Class.create(
/** @scope MyClass */
{
	/**
	 * @constructor
	 * @param foo
	 */
	initialize: function(foo) {
		// do something
		this.foo = foo;
	},
	
	/**
	 * @return foo
	 */
	getFoo: function() {
		return this.foo;
	}
} );

Is there anything I can do to make this work or is this style simply
not supported? Any plans to support it? We're pretty dependent on
prototype's class support.

Cheers,
noah

Re: [Jsdoc-user] jsdoc finds function declarations in constant string

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

Hi,

> /**
>  * Internal use
>  * @ignore
>  */
> this.dummy = "... function dummy_function1 ... function dummy_function2
> ...."
>
> I have variables which contain parts of a code.
> The problem is that jsdoc finds all those function declarations in a
> constant strings and includes them into the document... :(
> I need to ignore all what's in static strings, and I don't know how to do it
> properly...
>
> I can see an ugly way to do it - write something like:
> this.dummy = "... fun"+"ction dummy_function1 ..."
> It helps, but I don't really think it's a nice solving.
>
> Can anyone suggest anything better?

This is definitely a bug in JSDoc (which isn't really being actively
maintained these days). I'll try to post a fixed version for this in
the next few days, but failing that, I would suggest you check out the
Jsdoc Toolkit (www.jsdoc.info). It is a lot more powerful and flexible
than JSDoc, and it will certainly not suffer from this bug.

Regards,

Gabriel

[Jsdoc-user] unsubscribe

[Mark M. <mmi...@ri...>]

=5F=5F=5F=5F=5F =20

From: jsd...@li...
To: jsd...@li...
Sent: Fri, 23 Nov 2007 16:37:55 -0500
Subject: Jsdoc-user Digest, Vol 10, Issue 1

Send Jsdoc-user mailing list submissions to
   jsd...@li...
 =20
  To subscribe or unsubscribe via the World Wide Web, visit
   https://lists.sourceforge.net/lists/listinfo/jsdoc-user
  or, via email, send a message with subject or body 'help' to
   jsd...@li...
 =20
  You can reach the person managing the list at
   jsd...@li...
 =20
  When replying, please edit your Subject line so it is more specific
  than "Re: Contents of Jsdoc-user digest..."
 =20
 =20
  Today's Topics:
 =20
     1. Does JSDoc support documenting JSON classes (Ahmed Javed)
     2. jsdoc with recursive option (Jacques Guellec)
     3. hello (=3D=3Fgb2312=3FB=3Fuai1ws6w=3F=3D)
     4. Documenting Name Spaces (Mark Mitchell)
     5. Re: Documenting Name Spaces (Gabriel Reid)
     6. RECURSION in JSDoc.pm (Marcel Ruff)
     7. Re: RECURSION in JSDoc.pm (Gabriel Reid)
     8. Re: RECURSION in JSDoc.pm (Marcel Ruff)
     9. Re: RECURSION in JSDoc.pm (Michael Mathews)
    10. jsdoc finds function declarations in constant string
        (Ilya Mamontov)
 =20
 =20
  ----------------------------------------------------------------------
 =20
  Message: 1
  Date: Thu, 23 Aug 2007 19:12:14 -0400
  From: "Ahmed Javed" <ahm...@gm...>
  Subject: [Jsdoc-user] Does JSDoc support documenting JSON classes
  To: jsd...@li...
  Message-ID:
   <af4...@ma...>
  Content-Type: text/plain; charset=3D"iso-8859-1"
 =20
  If I have the following singleton object, JSDoc doesn't produce any
  documentation for it=3F
 =20
  /**
   * My class foo
   */
  var foo =3D {
    /**
     * Bar function
     */
    bar: function() {
    }
  }
 =20
  Does JSDoc only work with functions defined starting with the function
  keyword=3F
  -------------- next part --------------
  An HTML attachment was scrubbed...
 =20
  ------------------------------
 =20
  Message: 2
  Date: Thu, 30 Aug 2007 10:29:17 +0200
  From: Jacques Guellec <jac...@ge...>
  Subject: [Jsdoc-user] jsdoc with recursive option
  To: jsd...@li...
  Message-ID: <6.2...@ge...>
  Content-Type: text/plain; charset=3D"us-ascii"
 =20
 =20
 =20
  Hi All,
 =20
  I'm currently looking at Jsdoc.
 =20
  My JavaScript code is distributed in a tree structure and contain no=
=20
  tag with '@'.
 =20
  When I run
  jsdoc.pl -r dir=5Fthat=5Fcontain=5Ftree=5Fstructure
  I can see that jsdoc recognize each file in it, but "js=5Fdocs=5Fout" =
is empty.
 =20
  If I run it over just one file, it produce docs.
 =20
  Could you explain me why "js=5Fdocs=5Fout" stay empty when I run jsdoc=
=20
  over a folder =3F
 =20
  Thanks,
 =20
 =20
  Jacques Guellec
 =20
  -------------- next part --------------
  An HTML attachment was scrubbed...
 =20
  ------------------------------
 =20
  Message: 3
  Date: Thu, 6 Sep 2007 14:43:00 +0800
  From: "=3D=3Fgb2312=3FB=3Fuai1ws6w=3F=3D" <gon...@gm...>
  Subject: [Jsdoc-user] hello
  To: "jsdoc-user" <jsd...@li...>
  Message-ID: <200...@gm...>
  Content-Type: text/plain; charset=3D"gb2312"
 =20
 =20
 =20
 =20
 =20
 =20
  =3F=3F=3F=3F=3F=3F
  2007-09-06
  -------------- next part --------------
  An HTML attachment was scrubbed...
 =20
  ------------------------------
 =20
  Message: 4
  Date: Thu, 25 Oct 2007 15:05:13 -0400
  From: Mark Mitchell <mmi...@ri...>
  Subject: [Jsdoc-user] Documenting Name Spaces
  To: jsd...@li...
  Message-ID: <472...@ri...>
  Content-Type: text/plain; charset=3DISO-8859-1
 =20
  I am new to JSDoc and I have not been able to find a way for it to
  produce documentation based on namespaces.
  Here is an example of how we are defining namespaces.Jsdoc fails to
  document this no matter which options I try.
  Since this is a valid way to define namespaces then Jsdoc should suppo=
rt it.
 =20
          =20
  /**
   *  Survey System name space
   *
   * @version      1.5
   * @author       Mark Mitchell <mmi...@ri...>
   * @name         Survey System
   * @constructor
   *
   */
  var SS =3D {  =20
 =20
      /**
       * Survey system form object set in pageInit()
       */
      objForm : null,
  =20
      /**
       * Page init function
       *
       * @access  public
       * @since    1.0
       * @return   void
       */
      pageInit : function() {
         this.objForm =3D document.forms[0];
         return;
      }
  }
 =20
 =20
 =20
 =20
 =20
 =20
 =20
 =20
  ------------------------------
 =20
  Message: 5
  Date: Thu, 25 Oct 2007 22:22:59 +0200
  From: "Gabriel Reid" <gab...@gm...>
  Subject: Re: [Jsdoc-user] Documenting Name Spaces
  To: "Mark Mitchell" <mmi...@ri...>
  Cc: jsd...@li...
  Message-ID:
   <a24...@ma...>
  Content-Type: text/plain; charset=3DISO-8859-1
 =20
  Hi Mark,
 =20
 =20
  > I am new to JSDoc and I have not been able to find a way for it to
  > produce documentation based on namespaces.
  > Here is an example of how we are defining namespaces.Jsdoc fails to
  > document this no matter which options I try.
  > Since this is a valid way to define namespaces then Jsdoc should sup=
port it.
 =20
  This is indeed a valid way to define a namespace in JavaScript. On the
  other hand, it could also be looked at as a valid way to define a
  variable, or a Singleton instance, or any other number of things. The
  point I'm getting at here is that JavaScript is a very flexible
  language, and JSDoc is somewhat limited in what it knows how to deal
  with.
 =20
  The good news is that there is a newer documentation tool that is
  somewhat similar to JSDoc which may be able to handle this: JsDoc
  Toolkit (http://www.jsdoc.info). JSDoc actually isn't really being
  actively maintained anymore, and support for constructs like this
  certainly aren't planned to be implemented, so you'll probably have a
  lot more luck with JsDoc Toolkit.
 =20
 =20
  Regards,
 =20
  Gabriel
 =20
 =20
 =20
  ------------------------------
 =20
  Message: 6
  Date: Sat, 27 Oct 2007 13:46:26 +0200
  From: Marcel Ruff <mr...@ma...>
  Subject: [Jsdoc-user] RECURSION in JSDoc.pm
  To: jsd...@li...
  Message-ID: <472...@ma...>
  Content-Type: text/plain; charset=3DISO-8859-1; format=3Dflowed
 =20
  Hi,
 =20
  again the recursion issue ...
 =20
  I'm using the current JSDoc-1.10.2 and
  the current perl v5.8.8 built for i586-linux-thread-multi.
 =20
  If i use RECURSION=3D2 JSDoc works fine
  but for any value > 2 it fails.
 =20
  Is there any work around / patch ... i can try to get
  JSDoc running with my Javascript=3F
  Does it really help if i build the perl 5.8.8 from source
  myself as stated in the FAQ=3F
 =20
  Thanks a lot,
  Marcel
 =20
  --
  http://watchee.net
 =20
 =20
 =20
  ------------------------------
 =20
  Message: 7
  Date: Sun, 28 Oct 2007 08:30:21 +0100
  From: "Gabriel Reid" <gab...@gm...>
  Subject: Re: [Jsdoc-user] RECURSION in JSDoc.pm
  To: "Marcel Ruff" <mr...@ma...>
  Cc: jsd...@li...
  Message-ID:
   <a24...@ma...>
  Content-Type: text/plain; charset=3DISO-8859-1
 =20
  Hi Marcel,
 =20
  > I'm using the current JSDoc-1.10.2 and
  > the current perl v5.8.8 built for i586-linux-thread-multi.
  >
  > If i use RECURSION=3D2 JSDoc works fine
  > but for any value > 2 it fails.
  >
  > Is there any work around / patch ... i can try to get
  > JSDoc running with my Javascript=3F
  > Does it really help if i build the perl 5.8.8 from source
  > myself as stated in the FAQ=3F
 =20
  The only workaround that I've encountered that works (sometimes) is a
  new build of perl. There are of course no guarantees that a new build
  will help, but having a more "basic" build seems to generally improve
  the situation. In the end, this is a bug in perl itself (perl should
  *never* segfault on something that is written in pure perl), so the
  options are pretty limited.
 =20
  Something else you may want to check out is the JsDoc Toolkit
  (www.jsdoc.info), which is a newer JavaScript documenting framework
  with much better support for dynamic JavaScript and no problems like
  this segfault one.
 =20
  Regards,
 =20
  Gabriel
 =20
 =20
 =20
  ------------------------------
 =20
  Message: 8
  Date: Sun, 28 Oct 2007 14:06:58 +0100
  From: Marcel Ruff <mr...@ma...>
  Subject: Re: [Jsdoc-user] RECURSION in JSDoc.pm
  To: jsd...@li...
  Message-ID: <472...@ma...>
  Content-Type: text/plain; charset=3DISO-8859-1; format=3Dflowed
 =20
  Gabriel Reid wrote:
  > Hi Marcel,
  >
  >  =20
  >> I'm using the current JSDoc-1.10.2 and
  >> the current perl v5.8.8 built for i586-linux-thread-multi.
  >>
  >> If i use RECURSION=3D2 JSDoc works fine
  >> but for any value > 2 it fails.
  >>
  >> Is there any work around / patch ... i can try to get
  >> JSDoc running with my Javascript=3F
  >> Does it really help if i build the perl 5.8.8 from source
  >> myself as stated in the FAQ=3F
  >>    =20
  >
  > The only workaround that I've encountered that works (sometimes) is =
a
  > new build of perl. There are of course no guarantees that a new buil=
d
  > will help, but having a more "basic" build seems to generally improv=
e
  > the situation. In the end, this is a bug in perl itself (perl should
  > *never* segfault on something that is written in pure perl), so the
  > options are pretty limited.
  >
  > Something else you may want to check out is the JsDoc Toolkit
  > (www.jsdoc.info), which is a newer JavaScript documenting framework
  > with much better support for dynamic JavaScript and no problems like
  > this segfault one.
  >  =20
  Hi Gabriel,
 =20
  the JSDoc-Toolkit - Cool work!
 =20
  It runs fine here but i have some questions about the links=20
  (cross-referencing):
 =20
  o Used parameter classes are no links which can be followed by a click=
, e.g.
        MySomething getSomething(Something2 something2);
     In the perl variant i can click on MySomething or Something2 to go =
to=20
  this Class.
     Is this a TODO feature or is it my configuration failure=3F
 =20
  o @link is planned for v1.4 - when is this scheduled=3F
 =20
  o Has somebody a javadoc look and feel template available=3F
 =20
  Thanks for the nice tool,
 =20
  regards,
  Marcel
  > Regards,
  >
  > Gabriel
  >
  >  =20
 =20
 =20
  --=20
  Marcel Ruff
  http://www.xmlBlaster.org
 =20
 =20
 =20
 =20
  ------------------------------
 =20
  Message: 9
  Date: Sun, 28 Oct 2007 15:40:28 +0000
  From: Michael Mathews <mi...@gm...>
  Subject: Re: [Jsdoc-user] RECURSION in JSDoc.pm
  To: jsd...@li...
  Message-ID: <A13...@gm...>
  Content-Type: text/plain; charset=3DUS-ASCII; delsp=3Dyes; format=3Dfl=
owed
 =20
  Hello Marcel,
 =20
  On 28 Oct 2007, at 1:06, Marcel Ruff wrote:
  > Hi Gabriel,
  >
  > the JSDoc-Toolkit - Cool work!
  >
 =20
  Muchos thanksos.
 =20
 =20
  > It runs fine here but i have some questions about the links
  > (cross-referencing):
  >
  > o Used parameter classes are no links which can be followed by a =20
  > click, e.g.
  >       MySomething getSomething(Something2 something2);
  >    In the perl variant i can click on MySomething or Something2 to =
=20
  > go to
  > this Class.
  >    Is this a TODO feature or is it my configuration failure=3F
 =20
  Not sure this is on the todo list yet, you may be the first to =20
  request it. If you want you can add it here:
       http://code.google.com/p/jsdoc-toolkit/issues/list
 =20
  > o @link is planned for v1.4 - when is this scheduled=3F
 =20
  There is no time/date set to that, as this is an all-volunteer =20
  operation, and unless someone volunteers a patch it depends on my =20
  availability to donate the work. I would guess it will happen within =
=20
  the next month though.
 =20
  >
  > o Has somebody a javadoc look and feel template available=3F
  >
 =20
  Use the "sunny" template. See http://www.jsdoctoolkit.org/docs/sunny/ =
=20
  for an example.
 =20
  > Thanks for the nice tool,
 =20
  Please note that JsDoc Toolkit is *not* a straight port of the perl =
=20
  based JSDoc.pm tool, and there hasn't even been much effort to keep =
=20
  it backwards compatible -- I'm not opposed to backwards compatibility =
=20
  of course, I just don't have the time to devote to that work while my =
=20
  first priority is a tool that does what the JsDoc Toolkit user group =
=20
  asks.
 =20
  You're welcome to join in the discussion though and any requests, =20
  suggestions, or patches will certainly be welcomed.
 =20
  Stop by http://groups.google.com/group/jsdoc-2
 =20
  Regards,
  Michael Mathews
 =20
 =20
 =20
 =20
  ------------------------------
 =20
  Message: 10
  Date: Sat, 24 Nov 2007 00:37:51 +0300
  From: "Ilya Mamontov" <ma...@gm...>
  Subject: [Jsdoc-user] jsdoc finds function declarations in constant
   string
  To: jsd...@li...
  Message-ID:
   <228...@ma...>
  Content-Type: text/plain; charset=3D"iso-8859-1"
 =20
  Hi everyone,
  I'm stuck with a problem using jsdoc.
  In my code there's a part like this:
  /**
  * Internal use
  * @ignore
  */
  this.dummy =3D "... function dummy=5Ffunction1 ... function dummy=5Ffu=
nction2
  ...."
 =20
  I have variables which contain parts of a code.
  The problem is that jsdoc finds all those function declarations in a
  constant strings and includes them into the document... :(
  I need to ignore all what's in static strings, and I don't know how to=
 do it
  properly...
 =20
  I can see an ugly way to do it - write something like:
  this.dummy =3D "... fun"+"ction dummy=5Ffunction1 ..."
  It helps, but I don't really think it's a nice solving.
 =20
  Can anyone suggest anything better=3F
 =20
  Thanks in advance
 =20
  P.S. I'm using jsdoc 1.10.2
  -------------- next part --------------
  An HTML attachment was scrubbed...
 =20
  ------------------------------
 =20
  ----------------------------------------------------------------------=
---
  This SF.net email is sponsored by: Microsoft
  Defy all challenges. Microsoft(R) Visual Studio 2005.
  http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
 =20
  ------------------------------
 =20
  =5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=
=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F=5F
  Jsdoc-user mailing list
  Jsd...@li...
  https://lists.sourceforge.net/lists/listinfo/jsdoc-user
 =20
 =20
  End of Jsdoc-user Digest, Vol 10, Issue 1
  *****************************************
   =20

[Jsdoc-user] jsdoc finds function declarations in constant string

[Ilya M. <ma...@gm...>]

Hi everyone,
I'm stuck with a problem using jsdoc.
In my code there's a part like this:
/**
* Internal use
* @ignore
*/
this.dummy = "... function dummy_function1 ... function dummy_function2
...."

I have variables which contain parts of a code.
The problem is that jsdoc finds all those function declarations in a
constant strings and includes them into the document... :(
I need to ignore all what's in static strings, and I don't know how to do it
properly...

I can see an ugly way to do it - write something like:
this.dummy = "... fun"+"ction dummy_function1 ..."
It helps, but I don't really think it's a nice solving.

Can anyone suggest anything better?

Thanks in advance

P.S. I'm using jsdoc 1.10.2

Re: [Jsdoc-user] RECURSION in JSDoc.pm

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

Hello Marcel,

On 28 Oct 2007, at 1:06, Marcel Ruff wrote:
> Hi Gabriel,
>
> the JSDoc-Toolkit - Cool work!
>

Muchos thanksos.


> It runs fine here but i have some questions about the links
> (cross-referencing):
>
> o Used parameter classes are no links which can be followed by a  
> click, e.g.
>       MySomething getSomething(Something2 something2);
>    In the perl variant i can click on MySomething or Something2 to  
> go to
> this Class.
>    Is this a TODO feature or is it my configuration failure?

Not sure this is on the todo list yet, you may be the first to  
request it. If you want you can add it here:
     http://code.google.com/p/jsdoc-toolkit/issues/list

> o @link is planned for v1.4 - when is this scheduled?

There is no time/date set to that, as this is an all-volunteer  
operation, and unless someone volunteers a patch it depends on my  
availability to donate the work. I would guess it will happen within  
the next month though.

>
> o Has somebody a javadoc look and feel template available?
>

Use the "sunny" template. See http://www.jsdoctoolkit.org/docs/sunny/  
for an example.

> Thanks for the nice tool,

Please note that JsDoc Toolkit is *not* a straight port of the perl  
based JSDoc.pm tool, and there hasn't even been much effort to keep  
it backwards compatible -- I'm not opposed to backwards compatibility  
of course, I just don't have the time to devote to that work while my  
first priority is a tool that does what the JsDoc Toolkit user group  
asks.

You're welcome to join in the discussion though and any requests,  
suggestions, or patches will certainly be welcomed.

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

Regards,
Michael Mathews

Re: [Jsdoc-user] RECURSION in JSDoc.pm

[Marcel R. <mr...@ma...>]

Gabriel Reid wrote:
> Hi Marcel,
>
>   
>> I'm using the current JSDoc-1.10.2 and
>> the current perl v5.8.8 built for i586-linux-thread-multi.
>>
>> If i use RECURSION=2 JSDoc works fine
>> but for any value > 2 it fails.
>>
>> Is there any work around / patch ... i can try to get
>> JSDoc running with my Javascript?
>> Does it really help if i build the perl 5.8.8 from source
>> myself as stated in the FAQ?
>>     
>
> The only workaround that I've encountered that works (sometimes) is a
> new build of perl. There are of course no guarantees that a new build
> will help, but having a more "basic" build seems to generally improve
> the situation. In the end, this is a bug in perl itself (perl should
> *never* segfault on something that is written in pure perl), so the
> options are pretty limited.
>
> Something else you may want to check out is the JsDoc Toolkit
> (www.jsdoc.info), which is a newer JavaScript documenting framework
> with much better support for dynamic JavaScript and no problems like
> this segfault one.
>   
Hi Gabriel,

the JSDoc-Toolkit - Cool work!

It runs fine here but i have some questions about the links 
(cross-referencing):

o Used parameter classes are no links which can be followed by a click, e.g.
      MySomething getSomething(Something2 something2);
   In the perl variant i can click on MySomething or Something2 to go to 
this Class.
   Is this a TODO feature or is it my configuration failure?

o @link is planned for v1.4 - when is this scheduled?

o Has somebody a javadoc look and feel template available?

Thanks for the nice tool,

regards,
Marcel
> Regards,
>
> Gabriel
>
>   


-- 
Marcel Ruff
http://www.xmlBlaster.org