-
Notifications
You must be signed in to change notification settings - Fork 312
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
DOCS: Added auto-generated docs for auto-generated code. #2045
Conversation
There was a problem hiding this 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!
Packages/com.unity.inputsystem/InputSystem/Editor/AssetImporter/InputActionCodeGenerator.cs
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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
…ame to same in-line comment in example
…ntation since not automatically regenerated by import to reflect updates un auto-generated documentation.
Unfortunately some post-review updates on this PR:
|
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.
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:
Changed
,Fixed
,Added
sections.Area_CanDoX
,Area_CanDoX_EvenIfYIsTheCase
,Area_WhenIDoX_AndYHappens_ThisIsTheResult
.During merge:
NEW: ___
.FIX: ___
.DOCS: ___
.CHANGE: ___
.RELEASE: 1.1.0-preview.3
.After merge: