scj7t4/FREEDM — Issue #23: Documentation
Author: scj7t4
Created: 2011-12-07 19:34:59+00:00
State: open

I've just put up a new commit where I redid a bit of documentation and uploaded the doxygen files to http://scj7t4.github.com/FREEDM/

Almost everything is completely documented, other than there are no "one-liners" from Load Balancing and State Collection, If we want those (for example: http://scj7t4.github.com/FREEDM/annotated.html) then comments need to be added to the .hpp files in the style of:

```C++
/// 1 Line class description
class SOMECLASS
{
public:
/// brief function description
void myfunc();
private:
/// brief member description
int mymember;
};
```

Additionally, the coding standard recommends something different for the documentation immediately proceeding the class, but Doxygen seems happiest with the one line descriptor and then the coding standard recommended documentation inside the class.