Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: Added auto-generated docs for auto-generated code. #2045

Merged
merged 7 commits into from
Nov 11, 2024

Conversation

ekcoh
Copy link
Collaborator

@ekcoh ekcoh commented Nov 6, 2024

Description

Added auto-generated docs for auto-generated code based on ticket DOCF-6090 which contains user feedback about generated API surface not being documented. This is basically a bug.

Testing status & QA

Tested during development by generating source code from Project-wide Actions asset.

Overall Product Risks

Small, mainly affects code generator and related documentation.

  • Complexity: Small
  • Halo Effect: Small

Comments to reviewers

Review for mistakes in generated documentation. Test by generating source code from various assets and verify that documentation is linked and looks correct via e.g. intellisense tooltips in VS and Rider.

Checklist

Before review:

  • Changelog entry added.
    • Explains the change in Changed, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
    • Jira port for the next release set as "Resolved".
  • Tests added/changed, if applicable.
    • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
    • Performance tests.
    • Integration tests.
  • Docs for new/changed API's.
    • Xmldoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
    • The manual is updated, if needed.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • NEW: ___.
    • FIX: ___.
    • DOCS: ___.
    • CHANGE: ___.
    • RELEASE: 1.1.0-preview.3.

After merge:

  • Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

@ekcoh ekcoh marked this pull request as ready for review November 6, 2024 11:51
@ekcoh ekcoh requested review from duckets and jfreire-unity and removed request for jfreire-unity and ritamerkl November 6, 2024 12:03
@ekcoh ekcoh requested a review from Pauliusd01 November 6, 2024 19:51
Copy link
Collaborator

@duckets duckets left a comment

Choose a reason for hiding this comment

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

Great to see this added, thank you!

Copy link
Collaborator

@Pauliusd01 Pauliusd01 left a comment

Choose a reason for hiding this comment

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

Read through the example and seems fine to me, generated code for PWA asset and a custom one and I see the changes and VS22 tooltips fine as well

@ekcoh
Copy link
Collaborator Author

ekcoh commented Nov 11, 2024

Unfortunately some post-review updates on this PR:

  • 032f3aa fixes a formatting bug fix where a whitespace was inserted after doc-syntax prefix if text string was empty.
  • a1b8585 is a regeration of generated files in repo that didn't correctly reflect the changes to generator. These currently require manual regeneration if the original asset isn't reimported.
  • aded9d0 was a formatting fix that shouldn't have been required if 032f3aa was committed first.

@ekcoh ekcoh merged commit 8b860b7 into develop Nov 11, 2024
77 checks passed
@ekcoh ekcoh deleted the docf-6090-auto-generated-docs-for-auto-generated-code branch November 11, 2024 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants