build(aio): fix addNotYetDocumentedProperty processor

[petebacondarwin]

It was running too late and so was being confused by the
description being split into shortDescription and description
properties.

I also took the opportunity to simplify it and make the docTypes configurable.

Closes #22748

[mary-poppins]

You can preview 5b2b04f at https://pr22770-5b2b04f.ngbuilds.io/.

[gkalpak]

So, what about doc.constructorDoc and doc.members?

[petebacondarwin]

These are now covered by the docTypes = API_DOC_TYPES configuration.
Previously we were only checking EXPORT_DOC_TYPES

[gkalpak]

But afaict, there is this difference with how it worked before:

• Assume empty description, but documented constructor.
• Before: doc.notYetDocumented --> false
• Now: doc.notYetDocumented --> true

Did I miss something? Does that affect something in practice? Was it intentional?

[petebacondarwin]

That is true - also of members. I.E. if any constructor or member had docs then we don't mark the container.
But this logic seemed weird and overly complex. Also it didn't account for static members either. So I ditched it.
We can do that sort of analysis at render time or in a second processor if it is deemed important.
At the moment no one uses this report or is even aware of it so we are somewhat free to redefine it.

[gkalpak]

One last thing: What happens if there is a shortDescription only (but no description)?
Wouldn't it still be (incorrectly) marked as notYetDocumented?

[petebacondarwin]

At this point (https://github.com/angular/angular/pull/22770/files#diff-b55272a29cea0094031753ed50026aeeR5) we explicitly configure the processor to run before the splitDescription processor. So at this stage there is only a description property.

[gkalpak]

Doh! I thought shortDescription could be a standalone tag, but apparently not.
LGTM then (but it will break if we make shortDescription a standalone tag 😛).

[angular-automatic-lock-bot]

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}