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