Skip to content

Commit

Permalink
added doxygen comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Ruben Noroian committed Dec 5, 2024
1 parent d86aea2 commit a21e9db
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions middleware/include/high_pass.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,20 @@ typedef struct {
} high_pass_t;

/**
* @brief
* @brief Initiailzing the high pass filter with filter coefficient & desired scale
*
* @param alpha
* @param scale
* @param filter
* @param alpha filter coefficient controlling freq response
* @param scale desired scaling for filter
* @param filter pointer to a new high pass struct
*/
void high_pass_init(float alpha, float scale, high_pass_t *filter);

/**
* @brief
* @brief Function applying filter to a new sample, returning the filtered output
*
* @param filter
* @param input
* @return float
* @param filter passing pointer to initialized high pass struct
* @param input new sample to be filtered
* @return float Filtered & Scaled output value based on prev values
*/
float high_pass(high_pass_t *filter, float input);

Expand Down

0 comments on commit a21e9db

Please sign in to comment.