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.

Sign up for GitHub

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

Jump to bottom

Doxygen comments #156

Closed
wants to merge 8 commits into from
Closed

Doxygen comments #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
12f8555
start adding documentation to undocumented create functions
chrehall68 Jun 24, 2022
e2cf67d
finish documenting create functions
chrehall68 Jun 24, 2022
b522e49
document threading functions.
chrehall68 Jun 24, 2022
93dae1e
replace NYI w/ not yet imp...
chrehall68 Jun 24, 2022
f13a918
finish the button functions
chrehall68 Jun 24, 2022
c74fbd3
update documentation, doxyfiles
chrehall68 Jun 25, 2022
2c21790
format with spaces instead of tabs
chrehall68 Jun 25, 2022
3435a93
Merge branch 'master' into doxygen-comments
chrehall68 Jun 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,603 changes: 1,722 additions & 881 deletions doxygen/Doxyfile
View file
Open in desktop

Large diffs are not rendered by default.

2,607 changes: 1,724 additions & 883 deletions doxygen/Doxyfile++
View file
Open in desktop

Large diffs are not rendered by default.

77 changes: 37 additions & 40 deletions include/kipr/accel.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,54 +15,51 @@
*/

#ifdef __cplusplus
extern "C" {
extern "C"
{
#endif

/*!
* \brief Gets the sensed x acceleration
* \description Wallaby: +/- 2G range, 1024 per G
* \description Wombat: +/- 2G range, 1024 per G
* \description This should be approximately 0 when at rest and flat on a table
* \return The latest signed x acceleration value
* \ingroup accel
*/
signed short accel_x();


/*!
* \brief Gets the sensed y acceleration
* \description Wallaby: +/- 2G range, 1024 per G
* \description Wombat: +/- 2G range, 1024 per G
* \description This should be approximately 0 when at rest and flat on a table
* \return The latest signed y acceleration value
* \ingroup accel
*/
signed short accel_y();
/*!
* \brief Gets the sensed x acceleration
* \details Wallaby: +/- 2G range, 1024 per G
* \details Wombat: +/- 2G range, 1024 per G
* \details This should be approximately 0 when at rest and flat on a table
* \return The latest signed x acceleration value
* \ingroup accel
*/
signed short accel_x();

/*!
* \brief Gets the sensed y acceleration
* \details Wallaby: +/- 2G range, 1024 per G
* \details Wombat: +/- 2G range, 1024 per G
* \details This should be approximately 0 when at rest and flat on a table
* \return The latest signed y acceleration value
* \ingroup accel
*/
signed short accel_y();

/*!
* \brief Gets the sensed z acceleration
* \description Wallaby: +/- 2G range, 1024 per G
* \description Wallaby: This should be approximately -1024 when at rest and flat on a table
* \description Wombat: +/- 2G range, 1024 per G
* \description Wombat: This should be approximately -512 when at rest and flat on a table
* \return The latest signed z acceleration value
* \ingroup accel
*/
signed short accel_z();

/*!
* \brief Gets the sensed z acceleration
* \details Wallaby: +/- 2G range, 1024 per G
* \details Wallaby: This should be approximately -1024 when at rest and flat on a table
* \details Wombat: +/- 2G range, 1024 per G
* \details Wombat: This should be approximately -512 when at rest and flat on a table
* \return The latest signed z acceleration value
* \ingroup accel
*/
signed short accel_z();

/*!
* Initiates a calibration of the accelerometer
* \note Not Yet Implemented
* \return 1: success 0: failure
* \ingroup accel
*/
int accel_calibrate();
/*!
* Initiates a calibration of the accelerometer
* \note Not Yet Implemented
* \return 1: success 0: failure
* \ingroup accel
*/
int accel_calibrate();

#ifdef __cplusplus
}
#endif


#endif /* INCLUDE_WALLABY_ACCEL_H_ */
Loading