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

Fixed warnings in doc comments #33

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed warnings in doc comments #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions source/Helper/PTDIntelHex.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ - (NSUInteger)numberFromHexString:(NSString *)hexString

/**
* Parse raw bytes from a string containing ASCII hex characters.
* @param The string with ASCII hex characters
* @param hexString The string with ASCII hex characters
* @param offset The offset of the first character in the slice. 0 starts from the beginning of the string.
* @param len The number of characters in the slice
* @return An NSData object containing the raw bytes from the hex string
Expand All @@ -154,7 +154,7 @@ - (NSData *)bytesFromHexString:(NSString *)hexString offset:(NSUInteger)offset l

/**
* Parse raw bytes from a string containing ASCII hex characters.
* @param The string with ASCII hex characters
* @param hexString The string with ASCII hex characters
* @return An NSData object containing the raw bytes from the hex string
*/
- (NSData *)bytesFromHexString:(NSString *)hexString
Expand Down
2 changes: 1 addition & 1 deletion source/Profiles/OAD/OadProfile.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ - (void)enableNotify
/**
* Offer one OAD image to Bean.
*
* @param firstImage YES to offer the first image to Bean, NO to offer the next unoffered image
* @param offerFirstImage YES to offer the first image to Bean, NO to offer the next unoffered image
*/
- (void)offerOneImageUsingFirstImage:(BOOL)offerFirstImage
{
Expand Down
6 changes: 3 additions & 3 deletions source/Public/PTDBean.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ typedef NS_ENUM(NSUInteger, BeanBluetoothError) {
* A serious error has occurred that Bean can't resolve. The client must resolve this issue.
*
* @param bean The Bean that encountered this issue
* @param bluetoothError a BeanBluetoothError indicating what went wrong
* @param error a BeanBluetoothError indicating what went wrong
*/
- (void)bean:(PTDBean *)bean bluetoothError:(BeanBluetoothError)error;

Expand Down Expand Up @@ -470,7 +470,7 @@ typedef NS_ENUM(NSUInteger, BeanBluetoothError) {
/**
* Temporarily turns the Bean's Arduino on or off.
*
* @param "YES" sets the Arduino to a powered-on state and "NO" is a shutdown state.
* @param state "YES" sets the Arduino to a powered-on state and "NO" is a shutdown state.
*/
-(void)setArduinoPowerState:(ArduinoPowerState)state;
/**
Expand Down Expand Up @@ -607,7 +607,7 @@ typedef NS_ENUM(NSUInteger, BeanBluetoothError) {
/**
* Requests Bean's current scratch bank data.
* @discussion When you call this method to read one of the Bean's scratch banks, the bean calls the [PTDBeanDelegate bean:didUpdateScratchBank:withValue:] method of its delegate object.
* @param The index of the scratch bank to request, from 1 to 5.
* @param bank The index of the scratch bank to request, from 1 to 5.
* @see [PTDBeanDelegate bean:didUpdateScratchBank:withValue:]
*/
-(void)readScratchBank:(NSInteger)bank;
Expand Down