Skip to content

Conversation

@VaclavElias
Copy link
Contributor

PR Details

Related Issue

n/a

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.

docs: Update documentation in BodyComponent and IServo

  • In the BodyComponent.cs file, updated the documentation comment to specify the full namespace for the INarrowPhaseCallbacks interface, changing it from <see cref="INarrowPhaseCallbacks"/> to <see cref="global::BepuPhysics.CollisionDetection.INarrowPhaseCallbacks"/>.
  • In the IServo.cs file, modified the documentation comment to change the reference from <see cref="MaximumForce"/> to <see cref="ServoMaximumForce"/>.

PR Classification

Documentation update to improve clarity and accuracy of code references.

PR Summary

This pull request enhances the documentation in two files to provide clearer references to specific interfaces and properties.

  • BodyComponent.cs: Updated the reference to INarrowPhaseCallbacks to include its namespace for better clarity.
  • IServo.cs: Changed the documentation reference from MaximumForce to ServoMaximumForce to accurately reflect the property being described.

- In the `BodyComponent.cs` file, updated the documentation comment to specify the full namespace for the `INarrowPhaseCallbacks` interface, changing it from `<see cref="INarrowPhaseCallbacks"/>` to `<see cref="global::BepuPhysics.CollisionDetection.INarrowPhaseCallbacks"/>`.
- In the `IServo.cs` file, modified the documentation comment to change the reference from `<see cref="MaximumForce"/>` to `<see cref="ServoMaximumForce"/>`.
@VaclavElias
Copy link
Contributor Author

..docfx was complaining so I corrected those xml comments.

@VaclavElias VaclavElias added the area-Doc Issues related to documentation and XML comments label Sep 5, 2025
@Eideren Eideren merged commit c26abe8 into stride3d:master Sep 6, 2025
7 checks passed
@Eideren
Copy link
Collaborator

Eideren commented Sep 6, 2025

Thanks !

@VaclavElias VaclavElias deleted the xml-bepu-comments-fix branch September 6, 2025 20:48
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.

2 participants