Create documentation for library. about geometry3sharp HOT 7 OPEN

would you pay for it?

from geometry3sharp.

i see. yes my preference is for "egyptian" brackets, regardless of what MS thinks =). Generally the lower-case / underscores names are supposed to only be internal to classes, where I have to maintain complicated things and I find it much easier to read when I come back 6 months later. But those names have leaked out in some places, for expediency.

Much of the geometric-algorithms code (primitive distances and intersections, approximation, solvers) is ported from geometrictools.com GTEngine, literally cut-paste and then fix-up compile problems and glaring performance issues. I don't have time to rewrite these to be stylistically consistent, and keeping the code as similar as possible will make it easier to port over future bugfixes in the C++ code.

As for the original request @Firstborned, basically this is a library I am developing for use in consulting projects and my own products, and nobody is paying me to write documentation. I have a hard time imagining anyone paying my hourly consulting rate for documentation-writing, but if you are willing, we can discuss further =)

from geometry3sharp.

Should I?

from geometry3sharp.

I would pay for a rewrite that follows C# conventions 😝

from geometry3sharp.

which conventions?

(sorry, ~20 year c++ programmer and roughly half the library is line-for-line ports of c++ code)

from geometry3sharp.

I mentioned it in jest, the library is great, not complaining at all. You can tell it's being written by a C++ programmer, though.
If you really want to follow C# guidelines you can have a look here:
https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/
Most immediately obvious is the naming conventions. For example, some method names are lower case, use of underscores between words, use of contractions, use of 'Egyptian brackets'.

from geometry3sharp.

The project is already well documented... just need to extract the comments from the code. then Documents get.

Doxygen shoul do...

from geometry3sharp.