NotificationsYou must be signed in to change notification settings
Fork4.9k
Star45.4k

Upgrade Webdoc#6985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

bigtimebuddy merged 9 commits intodevfromdev-webdoc-upgrade

Dec 3, 2020

Merged

Upgrade Webdoc#6985

bigtimebuddy merged 9 commits intodevfromdev-webdoc-upgrade

Dec 3, 2020

Conversation

Copy link

Member

bigtimebuddy commentedNov 9, 2020

Upgrade Webdoc and template to the latest versions.

Bump webdoc

33b0b7b

bigtimebuddy requested a review fromShukantPal

November 9, 2020 14:47

Copy link

MemberAuthor

bigtimebuddy commentedNov 9, 2020

@SukantPal I'm seeing a bunch of errors here.

{@assembly-mod resolve-assigned-members} failed to resolve these symbols:          useDeprecated.accessibility [to PIXI]         useDeprecated.interaction [to PIXI]         useDeprecated.prepare [to PIXI]         useDeprecated.extract [to PIXI]         useDeprecated.extras [to PIXI]         useDeprecated.fromFrame [to TextureAny]         useDeprecated.fromImage [to TextureAny]         useDeprecated.mesh [to PIXI]         useDeprecated.particles [to PIXI]         useDeprecated.ticker [to PIXI]         useDeprecated.loaders [to PIXI]         useDeprecated.addPixiMiddleware [to PIXI.Loader]         useDeprecated._renderWebGL [to PIXI.Container]         useDeprecated.renderWebGL [to PIXI.DisplayObject]         useDeprecated.renderAdvancedWebGL [to PIXI.Container]         useDeprecated.loadSource [to BaseTextureAny]         useDeprecated.fromCanvas [to TextureAny]         useDeprecated.fromSVG [to TextureAny]         useDeprecated.copy [to PIXI.Matrix]         useDeprecated.setState [to PIXI.StateSystem]         useDeprecated.fromVideo [to SpriteAny]         useDeprecated.fromVideo [to TextureAny]         useDeprecated.mixins [to PIXI.utils][DocParser]: Failed to parse doc for (@Unnamed){@packages/basis/src/Basis.ts<NaN, NaN>}[DocParser]: Failed to parse doc for (@Unnamed){@packages/basis/src/Basis.ts<NaN, NaN>}[DocParser]: Failed to parse doc for (@Unnamed){@packages/basis/src/Basis.ts<NaN, NaN>}[TagParser]:{@} @typedef has not defined the {OriginalType}; defaulting to {any}[TagParser]:{@} @typedef has not defined the {OriginalType}; defaulting to {any}[DocParser]: Failed to parse doc for (@Unnamed){@packages/compressed-textures/src/loaders/CompressedTextureLoader.ts<NaN, NaN>}[DocParser]: Failed to parse doc for (@Unnamed){@packages/compressed-textures/src/loaders/CompressedTextureLoader.ts<NaN, NaN>}[DocParser]: Failed to parse doc for (@Unnamed){@packages/compressed-textures/src/resources/CompressedTextureResource.ts<NaN, NaN>}[TagParser]:{@AbstractMultiResource.constructor} Parameter "options" does not have a "-" token preceeding description <Options to for Resource constructor>undefined crashed findDoc in @webdoc/model[undefined doesn't point to a doc]: undefinedpixi-webdoc-template took 8561ms to run!@webdoc took 12237ms to run!

bigtimebuddy added this to thev5.4.0 milestone

Nov 9, 2020

Copy link

Member

ShukantPal commentedNov 9, 2020•
edited
Loading

Nice! I think we need to add a@instance tag to the following locations b/c of some webdoc problems:

Copy link

Member

ShukantPal commentedNov 9, 2020

Good things:

You see two lineStyle methods:http://pixijs.download/dev-webdoc-upgrade/docs/PIXI.Graphics.html#lineStyle
The UPDATE_PRIORITY bug is fixed:http://pixijs.download/dev-webdoc-upgrade/docs/PIXI.html#UPDATE_PRIORITY

Bad things:

PIXI.BitmapFont.from links are still partially missing. This is weird since the pixi-api website has them correct:
- https://sukantpal.github.io/pixi-api/PIXI.BitmapFont.html#from
- http://pixijs.download/dev-webdoc-upgrade/docs/PIXI.BitmapFont.html#from

Copy link

Member

ShukantPal commentedNov 9, 2020

@bigtimebuddy As for the errors, those existed before this PR. I can explain them here:

useDeprecated links - Those, I believe, are expected. For example, you assignPIXI.accessiblity, even thoughPIXI is not a documentedsymbol. webdoc's symbol assembly has no way to resolveaccessibility toPIXI, untilafter the documents have been parsed. (Specifically, the@namespace PIXI document). Hence, the document assembler is successfully able to resolveaccessibility toPIXI later on. This is why webdoc doesn't abort even after those errors.

https://github.com/pixijs/pixi.js/blob/068e0af7f2851c51618b463b7fccc555e6ffb4b0/bundles/pixi.js/src/useDeprecated.ts#L67

Failed to parse doc: Those are because webdoc still doesn't support documenting TypeScript types:

/** * Webdoc will fail to understand what this is :P */typeBasis={prop:string};

Typedef has not defined original type - somewhere we've have a@typedef Name instead of@typedef {object} Name. I apologize for the lack of context (i.e. file name or line number).
AbstractMultiResource constructor stuff, notice the lack of a- between[options] andOptions to...:

https://github.com/pixijs/pixi.js/blob/068e0af7f2851c51618b463b7fccc555e6ffb4b0/packages/core/src/textures/resources/AbstractMultiResource.ts#L26

Copy link

MemberAuthor

bigtimebuddy commentedNov 9, 2020

@SukantPal would you mind making those fixes on this PR? I think you have a good idea where they need to be changed.

ShukantPal added2 commits

November 14, 2020 10:49

Add@instanceand fix typedefs

92386ff

Fix AbstractMultiResource constructor

2f0abd0

Copy link

codecov-io commentedNov 14, 2020•
edited
Loading

Codecov Report

Merging#6985 (1692b70) intodev (b88eb1a) willnot change coverage.
The diff coverage isn/a.

@@            Coverage Diff            @@##               dev     #6985   +/-   ##=========================================  Coverage   100.00%   100.00%           =========================================  Files           17        17             Lines          704       704           =========================================  Hits           704       704

Continue to review full report at Codecov.

Legend -Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing data
Powered byCodecov. Last updateb88eb1a...1692b70. Read thecomment docs.

ShukantPal approved these changes

Nov 15, 2020

View reviewed changes

Copy link

Member

ShukantPal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I'll update pixi-webdoc-template next weekend. I've been trying to fix all the type-checking errors in webdoc from Flow - except there are literally thousands (yes, 2200 on @webdoc/parser itself). That number is kind of inflated because some lines have up to 50 errors.

Once that's done, I'll get time again to fix pixi-webdoc-template.

Upgrade webdoc

8de7c23

Copy link

Member

ShukantPal commentedNov 22, 2020

So I republished webdoc 1.1.2 and then pixi-webdoc-template 1.1.3, and those should fix theBitmapFont.from links.

Merge branch 'dev' into dev-webdoc-upgrade

7b85817

Copy link

Member

ShukantPal commentedNov 22, 2020

Well shoot, internal links to static method are broken. The fragment in the URL for static method contains the random ID generated for their docs, instead of their name. I guess we'll have to wait :(