Skip to content

Use XML documentation comments #60

Open

Description

@Happypig375

Right now the comments look like this:

        /// Solves the position of a mover that satisfies the given collision planes.
        /// @param targetDelta the desired movement from the position used to generate the collision planes
        /// @param planes the collision planes
        /// @param count the number of collision planes
        public static B2PlaneSolverResult b2SolvePlanes(B2Vec2 targetDelta, Span<B2CollisionPlane> planes, int count)

This is not C#'s way of expressing code documentation, and they are not recognized by tooling like code editors.
They should be ported as XML documentation instead:

        /// <summary>Solves the position of a mover that satisfies the given collision planes.</summary>
        /// <param name="targetDelta">the desired movement from the position used to generate the collision planes</param>
        /// <param name="planes">the collision planes</param>
        /// <param name="count">the number of collision planes</param>
        public static B2PlaneSolverResult b2SolvePlanes(B2Vec2 targetDelta, Span<B2CollisionPlane> planes, int count)

Activity

  1. VaclavElias commented on Nov 24, 2025

    @VaclavElias
    Contributor

    Here, my contribution, feel free to improve https://github.com/ikpil/Box2D.NET/tree/main/tools/Box2D.NET.CommentConverter

    ikpil just need to hook it to his deployment. So when the NuGet packages are build, the converter is run before.

    I think, it can't be done before. The source needs to stay with original comments so it can be easier to port and sync with the upstream?

  2. VaclavElias commented on Nov 24, 2025

    @VaclavElias
    Contributor

    Here is my PR #32 there is definitelly some space for improvemnts.

    Also, I was thinking to speak to/check with Erin, if he could make the comments more consistent so they are easier to port and convert 🤣

  3. ikpil commented on Dec 21, 2025

    @ikpil
    Owner

    inevitable fate of porting 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions