Skip to content

Conversation

@VaclavElias
Copy link
Contributor

@VaclavElias VaclavElias commented Mar 3, 2024

PR Details

This PR is fixing numerous XML comments issues, around 60.

Description

  • Fixing typos
  • Fixing cref references
  • Removing cref references for unknown, none existing references

Note that some references are not working because we have the same namespaces in different assemblies and then some references are not working unfortunatelly, such cref was removed.

Once merged, these updates will be automatically applied to Stride API in the next Stride Docs release.

Related Issue

#1681

Motivation and Context

This xml comments are rendered in our Stride Docs and ideally they should work.

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My change requires a change to the documentation.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have built and run the editor to try this change out.

feat: Release.yml added for PR categorisation
@VaclavElias VaclavElias added the area-Doc Issues related to documentation and XML comments label Mar 10, 2024
@VaclavElias
Copy link
Contributor Author

With the latest commit, this reduces the Stride Docs warnings to 79.

@VaclavElias
Copy link
Contributor Author

Hello, can this be merged?

Copy link
Collaborator

@Jklawreszuk Jklawreszuk left a comment

Choose a reason for hiding this comment

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

Looks legit to me 👌😃

@VaclavElias
Copy link
Contributor Author

Thanks for checking this for me @Jklawreszuk. Please, can this be merged, so we can improve our docs?

@Eideren Eideren merged commit dc9ceb4 into stride3d:master Apr 10, 2024
@Eideren
Copy link
Collaborator

Eideren commented Apr 10, 2024

Thanks !

@VaclavElias VaclavElias deleted the xml-comments-updates-4 branch May 22, 2024 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-Doc Issues related to documentation and XML comments

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants