Skip to content

Commit

Permalink
Change the file comment to a type recognized by Doxygen.
Browse files Browse the repository at this point in the history
  • Loading branch information
ZhuYanzhen1 committed Oct 9, 2021
1 parent a1d0269 commit 872217c
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 13 deletions.
17 changes: 8 additions & 9 deletions program/algorithm/report.c
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
//
// Created by Lao·Zhu on 2021/9/23.
//
/**************************************************************************//**
\file report.c
\brief this file is used to write the report correlation function
of the feedback host computer.
\author Lao·Zhu
\version V1.0.1
\date 9. October 2021
******************************************************************************/

#include "main.h"

/*!
\brief report PID parameters and current user settings
\param[in] none
\param[out] none
\retval none
*/
void report_local_variable(void) {
unsigned int upload_var[10] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
Expand Down Expand Up @@ -62,9 +64,6 @@ void report_local_variable(void) {

/*!
\brief report angle and speed using medium capacity transport protocol
\param[in] none
\param[out] none
\retval none
*/
void report_angle_speed(void) {
unsigned char buffer[8] = {0, 0, 0, 0, 0, 0, 0, 0};
Expand Down
23 changes: 19 additions & 4 deletions program/main.c
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
//
// Created by Lao·Zhu on 2021/8/20.
//
/**************************************************************************//**
\file main.c
\brief miniFOC main source file, The relevant operations and main function
after unpacking of medium capacity transmission protocol are implemented in this document.
\author Lao·Zhu
\version V1.0.1
\date 9. October 2021
******************************************************************************/

#include "main.h"

/*!
\brief used to indicate the current status of miniFOC
\param
1 calibrate motor phase and sensor offset \n
2 enable the motor \n
3 disable the motor \n
4 return current parameters \n
*/
static volatile unsigned char minifoc_fsm_state = 0;

/*!
\brief user callback function for unpacking completion of medium capacity transport protocol
\param[in] pid: medium capacity transport protocol package id
\param[in] data: received data array of size 8 bytes
\param[out] none
\retval none
*/
void mdtp_callback_handler(unsigned char pid, const unsigned char *data) {
Expand Down Expand Up @@ -100,6 +112,9 @@ void mdtp_callback_handler(unsigned char pid, const unsigned char *data) {
}
}

/*!
\brief main function
*/
int main(void) {
/* 4 bits for preemption priority 0 bits for subpriority */
nvic_priority_group_set(NVIC_PRIGROUP_PRE4_SUB0);
Expand Down

0 comments on commit 872217c

Please sign in to comment.