feat(dgeni): add deprecated field to API doc

[griest024]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/graycoreio/daffodil/blob/develop/CONTRIBUTING.md#commit
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Fixes: #3499

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

[griest024]

@xelaint I've added the deprecated field to API docs, its ready for UI updates.

[xelaint]

@griest024 I'm not seeing the deprecated tag on any of the deprecated classes?

[griest024]

@griest024 I'm not seeing the deprecated tag on any of the deprecated classes?

It should be on the JSON document. I wasn't sure how to wire it up to the UI

[xelaint]

@griest024 Something like this. I think I might need to create a docs specific article component to render the UI I want in docs.

[griest024]

blocked by #3554

[xelaint]

Assuming we need #3550 merged before doing this? No longer blocked by #3554

[griest024]

@xelaint ready for you to add UI. The deprecated field is on all API docs and props and methods. The value of this field is a message. Presence of the field indicates that the symbol is deprecated