Doxygen Documentation

Question

Doxygen Documentation

truell20 opened this issue 9 years ago · 6 comments

We need to switch to the doxygen comment style, so that the generated html documentation will include our descriptions.

Answer 1 · 2016-03-17T14:52:16.000Z

@joshuagruenstein description of doxygen documentation https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html

Answer 2 · 2016-03-18T23:47:20.000Z

Example:
http://fidoproject.github.io/docs/html/classnet_1_1_backpropagation.html
https://github.com/FidoProject/Fido/blob/master/Software/Backpropagation.h

Answer 3 · 2016-03-18T23:47:37.000Z

@FlyingGraysons, @joshuagruenstein agreed to do this.

Answer 4 · 2016-03-21T18:26:04.000Z

@joshuagruenstein @truell20
http://testgen.cvs.sourceforge.net/viewvc/testgen/testgen/
http://stackoverflow.com/a/32841496

Both are scripts (the second one is kinda broken) which claim to add doxygen. Probably will require some code changes, but looks easier than writing a parser from scratch

Answer 5 · 2016-03-24T21:28:14.000Z

@joshuagruenstein WireFitQLearn and QLearn are left

Answer 6 · 2016-03-26T10:15:59.000Z

Also the simulator, robby, and emitter