Skip to content

Commit

Permalink
Updated some objects that had doxygen errors.
Browse files Browse the repository at this point in the history
  • Loading branch information
srlm-io committed Aug 23, 2013
1 parent fd1a3b2 commit 9c05980
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 18 deletions.
22 changes: 11 additions & 11 deletions libpropeller/gpsparser/gpsparser.h
@@ -1,7 +1,7 @@
#ifndef LIBREDNINE_GPSPARSER_H_
#define LIBREDNINE_GPSPARSER_H_
#ifndef LIBPROPELLER_GPSPARSER_H_
#define LIBPROPELLER_GPSPARSER_H_

#include "librednine/serial/serial.h"
#include "libpropeller/serial/serial.h"

/** Receives and parses NMEA0183 GPS streams into C strings.
*
Expand All @@ -18,14 +18,14 @@ class GPSParser {

/** Create the parser and launch a new cog.
*
* @param rxPin the serial pin to receive data from the GPS.
* @param txPin the pin to transmit data to the GPS. If not used, set to -1.
* @param rx_pin the serial pin to receive data from the GPS.
* @param tx_pin the pin to transmit data to the GPS. If not used, set to -1.
* @param baud the baud rate to use for tranmission and receiving.
*/
bool Start(const int rxPin, const int txPin, const int baud) {
bool Start(const int rx_pin, const int tx_pin, const int baud) {
gps_serial_.Stop();
next_character_position_ = 0;
gps_serial_.Start(rxPin, txPin, baud);
gps_serial_.Start(rx_pin, tx_pin, baud);

recording_sentence_ = false;
return true;
Expand All @@ -40,8 +40,8 @@ class GPSParser {
/** Gets a NMEA string. Note that the returned string address is valid (will
* not be overwritten) until the next time GetStr() is called.
*
* The returned string includes all characters from the GPS except for the
* \r and \n (<CR><LF>) at the end.
* The returned string includes all characters from the GPS except for
* the \r and \n (<CR><LF>) at the end.
*
* Partial sentences may be thrown away (if a sentence is not being
* currently recorded).
Expand All @@ -62,7 +62,7 @@ class GPSParser {
* string). Otherwise, part of the string will be stored in one buffer, and
* part of the string will be stored in the other.
*
* @param s The buffer to use. Must be at least 85 characters long (the NMEA string length).
* @param string The buffer to use. Must be at least 85 characters long (the NMEA string length).
* @param maxBytes The maximum number of bytes to record in this string. Defaults to maximum NMEA sentence length.
* @returns NULL pointer if no string, null terminated string otherwise (in buffer @a s).
*/
Expand Down Expand Up @@ -136,4 +136,4 @@ class GPSParser {



#endif // LIBREDNINE_GPSPARSER_H_
#endif // LIBPROPELLER_GPSPARSER_H_
11 changes: 6 additions & 5 deletions libpropeller/max8819/max8819.h
Expand Up @@ -29,16 +29,17 @@ class Max8819 {
/**
Create the MAX8819 object, turn the power on, and turn off charging.
@warning pmic->SetCharge(Max8819::HIGH); @TODO(SRLM): There is some sort of bug where this *must* be in the code, otherwise it causes a reset.
@warning pmic->SetCharge(Max8819::HIGH);
@TODO(SRLM): There is some sort of bug where this *must* be in the code, otherwise it causes a reset.
The pins from the Propeller to the MAX8819 can be connected directly: no need
for current limiting resistors.
@param CENpin The pin connected to Charge Enable on the MAX8819
@param CHGPin The pin connected to (is) Charge(ing?) pin on the MAX8819
@param ENPin The pin connected to Enable123 pin on the MAX8819
@param DLIM1Pin The pin connected to DLIM1 pin on the MAX8819
@param DLIM2Pin The pin connected to DLIM2 pin on the MAX8819
@param CHGpin The pin connected to (is) Charge(ing?) pin on the MAX8819
@param ENpin The pin connected to Enable123 pin on the MAX8819
@param DLIM1pin The pin connected to DLIM1 pin on the MAX8819
@param DLIM2pin The pin connected to DLIM2 pin on the MAX8819
*/
void Start(int CENpin, int CHGpin, int ENpin, int DLIM1pin, int DLIM2pin);
Expand Down
1 change: 1 addition & 0 deletions libpropeller/ms5611/ms5611.h
Expand Up @@ -46,6 +46,7 @@ class MS5611 {
* initialization.
*
* @param newbus The I2C bus to use.
* @param AddressLSB The least significant byte of the I2C address. Use the enum constants.
*/
bool Init(I2C * newbus, const AddressLSB address = LSB_0) {

Expand Down
2 changes: 1 addition & 1 deletion libpropeller/numbers/numbers.h
Expand Up @@ -79,7 +79,7 @@ class Numbers {
* @warning Converted integers must be 32 bit integers. This range is not
* checked.
*
* @param n The 32 bit number to convert.
* @param number The 32 bit number to convert.
* @param num_digits The number of Hex digits to print.
* @param result_string The address to store the string representation. Defaults to the internal buffer if NULL.
* @returns The starting address of the string pointer.
Expand Down
2 changes: 1 addition & 1 deletion libpropeller/scheduler/scheduler.h
Expand Up @@ -69,7 +69,7 @@ class Scheduler {
*
* For testing only!
*
* @param hz The frequency is deci-hz (hz * 10)
* @param deci_hz The frequency is deci-hz (hz * 10)
* @return The number of clock cycles (ticks) per period.
*/
static unsigned int GetTicksPerPeriod(const int deci_hz) {
Expand Down

0 comments on commit 9c05980

Please sign in to comment.