You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is a pretty standard format that allows you to generate documentation on the code directly from the code itself. More information on doxygen is here.
Example:
Current code:
//******************************************************************************
//
// CompressBins
//
// Compress 16 BINS to 8. Used on some balloon or aircraft Status outputs.
//
// gHist 0..5 are 16 bin data
// gHist 6 is 6+7+8+9
// gHist 7 is 10+11+12+13+14+15
//
//******************************************************************************
void CompressBins(void)
{
...
}
Suggested format:
/**
* @brief Compress 16 BINS to 8. Used on some balloon or aircraft Status outputs.
*
* `gHist` 0..5 are 16 bin data
* `gHist` 6 is 6+7+8+9
* `gHist` 7 is 10+11+12+13+14+15
*
*/
void CompressBins(void)
{
...
}
The text was updated successfully, but these errors were encountered:
This is a pretty standard format that allows you to generate documentation on the code directly from the code itself. More information on doxygen is here.
Example:
Current code:
Suggested format:
The text was updated successfully, but these errors were encountered: