Skip to content

fix xmldoc warnings #4779

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Dec 20, 2020
Merged

fix xmldoc warnings #4779

merged 1 commit into from
Dec 20, 2020

Conversation

@chriselion
Copy link
Contributor

@chriselion chriselion commented Dec 18, 2020 •
edited
Loading

Proposed change(s)

Fix some problems with the cref during doc generation. We were previously getting

Invalid cref value "!:Heuristic(in ActionBuffers)" found in triple-slash-comments for Heuristic defined in Packages/com.unity.ml-agents/Runtime/Agent.deprecated.cs Line 20, ignored.
Invalid cref value "!:OnActionReceived(ActionBuffers)" found in triple-slash-comments for OnActionReceived defined in Packages/com.unity.ml-agents/Runtime/Agent.deprecated.cs Line 31, ignored.
Invalid cref value "!:OnActionReceived(ActionBuffers)" found in triple-slash-comments for GetAction defined in Packages/com.unity.ml-agents/Runtime/Agent.deprecated.cs Line 41, ignored.

Also update the Package Verification Suite and Package Manager Doc Tools versions for the DevProject - this lets us see these warnings in the package manager without having to jump through hoops.

Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)

https://unity.slack.com/archives/CBBSHA0HL/p1608264720069200

Types of change(s)

  • Documentation update

Checklist

Other comments

@chriselion chriselion requested a review from andrewcoh December 18, 2020 23:25
chriselion
chriselion commented Dec 18, 2020
View reviewed changes
DevProject/Packages/manifest.json
Comment on lines +14 to +15
"com.unity.package-manager-doctools": "1.7.0-preview",
"com.unity.package-validation-suite": "0.19.0-preview",
Copy link
Contributor Author

@chriselion chriselion Dec 18, 2020

Choose a reason for hiding this comment

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

These two were the main ones I wanted to update, others were auto-updated.

@chriselion chriselion merged commit ac28c2d into release_11_branch Dec 20, 2020
@delete-merged-branch delete-merged-branch bot deleted the r11-fix-doc-warnings branch December 20, 2020 02:15
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@andrewcoh andrewcoh andrewcoh approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@chriselion @andrewcoh