BMeshUnity icon indicating copy to clipboard operation
BMeshUnity copied to clipboard

Add XML doccomments to classes and methods

Open MechWarrior99 opened this issue 4 years ago • 1 comments

Add doccomments to classes and methods that follow the styling of other C# doccomments. This will need to be thoroughly reviewed to ensure that the accuracy of the comments.

Current State

Only the Vertex, Edge, Loop, Face class are commented so far. All comments in the Loop class including the one on the class it self need to be rewritten for more clarity in what they do, however I am not 100% clear on what they are doing my self. Edge.SetNext and Edge.SetPrev are not commented as I was not able to understand what they do in enough clarity to put in to a comment.

MechWarrior99 avatar Jul 14 '21 01:07 MechWarrior99

At this point almost all the methods in Vertex, Edge, Loop, Face, BMesh are covered.

The Attribute methods in BMesh are not as I was thinking of looking to see if there was a way to have less repeated code and don't want to rewrite the comments for them.

In Edge, SetNext(..) and SetPrev(..) are not commented since I don't know if they should stay public (from what I remember we had talked about how they shouldn't..?)

I also have included more of the technical comments in remarks.

I think at this point it is good for a 'doc comments part one'. Also, apologies for disappear for a while, the project I was using BMesh in had to be put on hold for a while, but I am getting back to it now!

MechWarrior99 avatar Feb 04 '22 21:02 MechWarrior99