Re: [Jsdoc-user] documenting a class?

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

Hi Kate,

> Thank you both for your responses! Your information totally answered my
> question. Also, thanks for helping me out the other week by showing me
> how to create a custom @example tag. I'd still like to figure out a way
> to ensure that the contents of this tag always appear AFTER all the
> other tags. One of your emails said there is no way to enforce this and
> that the only downside of a custom tag is that there's no telling where
> the information will appear (in other words, the "example" text could
> appear after the @returns info, it could appear before @returns, it
> could appear after @throws - - there is no way to specify where the
> example will appear). Is this true with all custom tags, or was this
> just true for the sample code snippet that you provided to me:
> 

Your understanding of custom tags in JSDoc is correct: there currently
isn't a way of forcing the order in which they're rendered in the
documentation.

If you feel that this is something you'd like to use, I could certainly
look into improving this functionality in JSDoc. I've basically left the
original functionality as it is since I first wrote it, as there hasn't
ever been all that much interest in the custom tag construct as it
currently stands.

Regards,

    Gabriel