Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert comments to Doxygen format #16

Open
lo-co opened this issue Dec 17, 2018 · 0 comments
Open

Convert comments to Doxygen format #16

lo-co opened this issue Dec 17, 2018 · 0 comments

Comments

@lo-co
Copy link

lo-co commented Dec 17, 2018

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)
{
    ...
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant