Enhance code documentation

[IAmNotHanni]

I documented every file one by one so we can git cherry-pick if required.
I will squash all commits and requested changes into one before merge.
Closes #81.

[IAmNotHanni]

@yeetari Already contacted me and pointed out that @class is a bit pointless. I will remove it entirely.

[IceflowRE]

I advise to use [doc] as the category. So [doc] Enhance code documentation

[IAmNotHanni]

• Remove [in] in @param since we agreed not to use call by reference anymore.

[IAmNotHanni]

I will do the sorting of Doxygen commands in another pull request, together with extending @brief into @details.

[IceflowRE]

Other general things:

1.

You wrote somewhere

Tries to find a queue family which supports VK_QUEUE_TRANSFER_BIT.

i just know it from the Python documentation but they advise to write instead:

Try to find a queue family which supports VK_QUEUE_TRANSFER_BIT.

2.

You can drop the @brief as every line with /// is automatically counted as it. (just if you want)

3.

Can you replace the /// with // in the bezier_curve.hpp?
As it is counted as the namesepace description.

4.

I didnt added a suggestion for all the ' issues.

[IAmNotHanni]

Other general things:

1.

You wrote somewhere

Tries to find a queue family which supports VK_QUEUE_TRANSFER_BIT.

i just know it from the Python documentation but they advise to write instead:

Try to find a queue family which supports VK_QUEUE_TRANSFER_BIT.

2.

You can drop the @brief as every line with /// is automatically counted as it. (just if you want)

3.

Can you replace the /// with // in the bezier_curve.hpp?
As it is counted as the namesepace description.

4.

I didnt added a suggestion for all the ' issues.

Replies

1. Done.
2. I will keep it for now.
3. Done.
4. I fixed that everywhere now.

[IceflowRE]

1. Right, I thought about that as well. I will postpone this to the next pull request to further improve the comments.
   Please send me links with guidelines for that.

PEP-0257

The docstring is a phrase ending in a period. It prescribes the function or method's effect as a command ("Do this", "Return that"), not as a description; e.g. don't write "Returns the pathname ...".

[IAmNotHanni]

Ok so in case there are no more requested changes, I will wait for your approval, squash and then merge :)

[IceflowRE]

Not sure, but as we agreed now to use the Python style we should add a note to it in the styling section in the documentation?
documentation/source/development/design/coding-style.rst

[IAmNotHanni]

Thank you for your review! Squash incoming :)