search

ssriram1992 / EPECsolve

Code to compute mixed-equilibrium in linear EPECs
https://ssriram1992.github.io/EPECsolve/html/index.html
GNU General Public License v3.0
6 stars 2 forks source link

Documentation for outerApproximation #33

Closed ssriram1992 closed 4 years ago

ssriram1992 commented 4 years ago

Please document functions as you write them. I find a large part of the code undocumented. For example the class Tree.

Some documentation templates also seem to be wrong - what should be description of a class/constructor falls in one of the members, and many members in the new headers are undocumented.

We should be able to compile the doxygen documentation, i.e., do make docDetailed and be able to generate the complete documentation.

gdragotto commented 4 years ago

The documentation will be completed as soon as a working commit is pushed. The one you have right now is a sketch