JSDocs for Phaser World Issue 97?

[Chad Elstad]

Richard, 

  I know you've tried a lot of things. So I just wanted to ask if you had tried the @memberof tag? We use that to link items together across files. So it seems to be the same or similar use case to the challenge you expressed in Phaser World Issue 97. I believe we used it in conjunction with the @class tag. Hopefully it'll help simplify what you're doing.

  We also use Docstrap to help us customize the results. Not exactly sure what your custom layout needs to be so I thought I would pass it on. Can't hurt, might help. ;)

  Hope this helps,

-Chad

[Richard Davey]

Yeah, that was the first thing I tried as I use it in v2 for similar reasons, but it wasn't having any of it.

More importantly, I can now do this:

/**

 * @include 'components/alpha.js'

 */

And it will pull in the docblock from that file into the class it is currently processing, something not possible with jsdoc natively.

I'm also making use of some custom tags like @demo to inline a working Phaser example (sort of like @iframe can do in some versions). And have extended the @tutorial concept so you don't have to keep all the tutorials together in the docs repo, but can keep them external.

I'm a lot happier with the flexibility that using an existing parser and my own custom output is giving me.

Cheers,

Rich

Photon Storm Ltd.

http://www.photonstorm.com

Skype: richard.davey

Twitter: @photonstorm

Registered in England and Wales.

Company ID: 8036404

VAT Number: 136 4333 27

--
You received this message because you are subscribed to the Google Groups "Phaser 3 Development" group.
To unsubscribe from this group and stop receiving emails from it, send an email to phaser3-dev+unsubscribe@googlegroups.com.
To post to this group, send email to phase...@googlegroups.com.
To view this discussion on the web, visit https://groups.google.com/d/msgid/phaser3-dev/94dab11b-fa4e-4682-8e87-5ce15c45835b%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.