[jala-dev] Re: Missing Methods when generating JsDoc with HopKit

  • From: <tobias.schaefer@xxxxxx>
  • To: <jala-dev@xxxxxxxxxxxxx>
  • Date: Fri, 9 Mar 2007 11:19:57 +0100

hi anton

> I just have to add the @member to my JsDoc-Block and the
> action/method/macro will be displayed at the right position in the
> documentation. For more infos on the @variables of JsDoc see [1] 

yes, actually, this is one way to do it.

another is to define your methods in a more javascript-compatible way (which is 
not less helma-like), ie. as prototype methods:

Root.prototype.main_action = function() {
   // ...

jsdoc should be able to create the docs correctly then, too. (as long as you 
don't mix the @member tag with a prototype defintion.)

however, the docs task actually should pre-process your files accordingly. it 
copies the javascript code files into a working directory and replaces the 
globally defined prototype methods with definitions as described above.

thus, i am wondering why this did not happen in your case.

maybe stefan pollach (who just subscribed to the list) can clarify this...


Other related posts: