Build Tooling: Update use of docgen to target only unstable APIs named by convention

[aduth]

Previously: #14557 (comment), #14565

The coding guidelines surrounding Unstable and Experimental APIs are very specific in how they ought to be named.

An experimental or unstable function or object should be prefixed respectively using __experimental or __unstable.

https://github.com/WordPress/gutenberg/blob/master/docs/contributors/coding-guidelines.md#experimental-and-unstable-apis

The current docgen script is lenient toward variations of these guidelines, due to preexisting issues described at #14557 (comment) .

Task: The script should be made non-lenient.

Reason: By removing leniency, it should help make clear where coding guidelines are being violated, since the invalid token would be included (wrongly) in the generated documentation.

Blocked by: Prexisting issues should be resolved (aligned to the guideline).

[aduth]

Blocked by: Prexisting issues should be resolved (aligned to the guideline).

Upon further investigation, I find there are two existing issues:

• UnstableRichTextInputEvent
  • Proposed renaming at Block Editor: Rename UnstableRichTextInputEvent to convention #15198
• unstable__bootstrapServerSideBlockDefinitions
  • This is tricky, because it is referenced upstream in WordPress (source)
  • It may be expected that this function can be eliminated as part of the ongoing work around the Blocks Registration RFC (Add the block registration RFC #13693)
  • For the above reasons, I suggest that once docgen: Omit docblocks with private tag #15173 is merged, we simply add a @private tag to the exported symbol's DocBlock as an alternative approach to exclude it from the documentation

[gziolo]

This is what is still left to do for unstable__bootstrapServerSideBlockDefinitions:

For the above reasons, I suggest that once #15173 is merged, we simply add a @Private tag to the exported symbol's DocBlock as an alternative approach to exclude it from the documentation

[ryanwelcher]

With #42198, we can also use @ignore.

[ryanwelcher]

@gziolo is this issue still relevant?

[gziolo]

With #42198, we can also use @ignore.

Yes, we should mark unstable__bootstrapServerSideBlockDefinitions with @ignore or something similar and consider this issue complete.