search

bit-hack / tack

Tack - The vector wrapper
0 stars 0 forks source link

Settle on a documentation format. #2

Closed bit-hack closed 8 years ago

bit-hack commented 8 years ago

It would be good to settle on a documentation format.

kbenzie commented 8 years ago

I have tooling that generate Doxygen like this from function signatures.

/// @brief Foo something.
///
/// @param bar Does girders.
///
/// @return Returns a number.
int foo(int bar)
kbenzie commented 8 years ago

Doxygen is also pretty much the defacto documentation format for C/C++ that I know of and it supports Markdown in comment blocks nowadays.

Are there any other solutions your were thinking of?

bit-hack commented 8 years ago

I wasn’t thinking of anything else, i've just not been involved in many projects using automated documentation so not sure whats out there. I'm happy to go with Doxygen and start documenting stuff with markdown :)

bit-hack commented 8 years ago

So if your happy, i'll close this issue as resolved?

kbenzie commented 8 years ago

I'm happy, and its always Markdown for the README ;)