search

AIAANortheastern / karman-avionics

The avionics system for the Northeastern University AIAA Project Karman rocket
1 stars 0 forks source link

Commented some code. Started trying to work with doxygen. #32

Closed dschonholtz closed 6 years ago

dschonholtz commented 6 years ago

This is a start. My main goal when going through and commenting code was to see if I could understand it when reading the code and if others would be able to later. I think we are pretty close to that point now.

We definitely could be more thorough about comments still. On top of that we aren't implementing doxygen styled comments in most places and I think we are going to need to start doing that if we want a decent doxygen manual. If we don't care, then we could close out the issue I just open 16 I think?

ADKaster commented 6 years ago

The @file directive has to be on the same line as the /** or it won't work. Search for structcmd.h in the doxygen documentation page 'Documenting the Code'

I.e. 

/** @file myfile.h
      @brief brief description

      Detailed description
*/

Instead of 

/**
      @file doesntwork.h

      Description
*/

Edit: actually, looking at my code for another project this isn't strictly true. AVR studio is not actually calling the makefile in the repository it's autogenerated. That's likely why it doesn't create the files on Windows

dschonholtz commented 6 years ago

This looks good to me and works in windows as well. I'm merging with master.