Small documentation tweaks

Author: Stephen Schiffli

Docs/gen_api_reference.sh

@@ -1 +1,5 @@
 appledoc -p "MetaWear iOS/macOS/tvOS API 2.8.0" --project-version "2.8.0" -c "MBIENTLAB INC" --company-id com.mbientlab --no-create-docset --no-repeat-first-par --ignore .m -o . ../MetaWear/Classes
+open html/index.html
+
+make html
+open build/html/index.html

MetaWear/Classes/Core/MBLEntityEvent.h

@@ -35,6 +35,9 @@
 
 #import <MetaWear/MBLEvent.h>
 
+/**
+ Base class for events that need a entry allocated on the MetaWear in order to function
+ */
 @interface MBLEntityEvent<ResultType> : MBLEvent<ResultType>
 
 @end

MetaWear/Classes/Core/MBLEntityModule.h

@@ -35,6 +35,9 @@
 
 #import <MetaWear/MBLModule.h>
 
+/**
+ Base class for modules that need a entries allocated on the MetaWear in order to function
+ */
 @interface MBLEntityModule : MBLModule
 
 @end

MetaWear/Classes/Core/MBLEvent.h

@@ -308,8 +308,8 @@ typedef void (^MBLNotificationHandler)(ResultType __nullable obj, NSError *__nul
 /**
  Create a new event that compares the current event's value to one or more data points
  @param op Operation type to perform
- @parma data Array of values to compare against
- @parma output Type of data to output
+ @param data Array of values to compare against
+ @param output Type of data to output
  @returns New event representing input values that meet the comparison condition
  */
 - (MBLFilter *)compareEventUsingOperation:(MBLComparisonOperation)op data:(NSArray<NSNumber *> *)data output:(MBLComparisonOutput)output;

MetaWear/Classes/Core/MBLFirmwareUpdateInfo.h

@@ -37,6 +37,9 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/**
+ Container for all the objects needed in order to begin a DFU with the Nordic DFU library
+ */
 @interface MBLFirmwareUpdateInfo : NSObject
 
 - (instancetype)initWithFirmwareUrl:(NSURL *)firmwareUrl

MetaWear/Classes/Modules/ANCS/MBLANCS.h

@@ -106,26 +106,35 @@ typedef NS_ENUM(uint8_t, MBLANCSNotificationAttributeID) {
 /**
  Event representing an ANCS event of one or more CategoryID's. Event callbacks will
  be provided an MBLANCSEventData object.
+ @param categoryIds Bitmask of categories you want to observe
  */
 - (MBLEvent<MBLANCSEventData *> *)eventWithCategoryIds:(MBLANCSCategoryID)categoryIds;
 
 /**
  Event representing an ANCS event of a specific CategoryID, EventID, and EventFlags.
  Event callbacks will be provided an MBLANCSEventData object.
+ @param categoryIds Bitmask of categories you want to observe
+ @param eventIds Bitmask of event types you want to observe
+ @param eventFlags Bitmask of event flags you want to observe
  */
 - (MBLEvent<MBLANCSEventData *> *)eventWithCategoryIds:(MBLANCSCategoryID)categoryIds
-                                                          eventIds:(MBLANCSEventID)eventIds
-                                                        eventFlags:(MBLANCSEventFlag)eventFlags;
+                                              eventIds:(MBLANCSEventID)eventIds
+                                            eventFlags:(MBLANCSEventFlag)eventFlags;
 
 /**
  Event representing an ANCS event of a specific CategoryID, EventID, EventFlags, and Notification Attribute.
  Event callbacks will be provided an MBLANCSEventData object.
+ @param categoryIds Bitmask of categories you want to observe
+ @param eventIds Bitmask of event types you want to observe
+ @param eventFlags Bitmask of event flags you want to observe
+ @param attributeId Type of attribute that should be matched @see attributeData
+ @param attributeData Data of attribute that should be matched @see attributeId
  */
 - (MBLEvent<MBLANCSEventData *> *)eventWithCategoryIds:(MBLANCSCategoryID)categoryIds
-                                                          eventIds:(MBLANCSEventID)eventIds
-                                                        eventFlags:(MBLANCSEventFlag)eventFlags
-                                                       attributeId:(MBLANCSNotificationAttributeID)attributeId
-                                                     attributeData:(NSString *)attributeData;
+                                              eventIds:(MBLANCSEventID)eventIds
+                                            eventFlags:(MBLANCSEventFlag)eventFlags
+                                           attributeId:(MBLANCSNotificationAttributeID)attributeId
+                                         attributeData:(NSString *)attributeData;
 
 @end
 

MetaWear/Classes/Modules/Accelerometer/AccelerometerBosch/AccelerometerBMA255/MBLAccelerometerBMA255MotionEvent.h

@@ -38,16 +38,14 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-
-@interface MBLAccelerometerBMA255MotionEvent : MBLEvent<MBLDataSample *>
-
-#pragma mark - Beta API (Subject to change)
-
 /**
  The BMI160 combines Slow/No-Motion and Any-Motion detection, so below
  we expose the raw registers as a first enabling step.  Over time this will become
  better encapsulated.
  */
+@interface MBLAccelerometerBMA255MotionEvent : MBLEvent<MBLDataSample *>
+
+#pragma mark - Beta API (Subject to change)
 
 #pragma mark - Slow-Motion/No-Motion
 /**

MetaWear/Classes/Modules/Accelerometer/AccelerometerBosch/AccelerometerBMI160/MBLAccelerometerBMI160MotionEvent.h

@@ -38,16 +38,14 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-
-@interface MBLAccelerometerBMI160MotionEvent : MBLEvent<MBLDataSample *>
-
-#pragma mark - Beta API (Subject to change)
-
 /**
  The BMI160 combines Slow/No-Motion and Any/Signification-Motion detection, so below
  we expose the raw registers as a first enabling step.  Over time this will become
  better encapsulated.
  */
+@interface MBLAccelerometerBMI160MotionEvent : MBLEvent<MBLDataSample *>
+
+#pragma mark - Beta API (Subject to change)
 
 #pragma mark - Slow-Motion/No-Motion
 /**

MetaWear/Classes/Modules/Accelerometer/AccelerometerBosch/MBLAccelerometerBoschLowOrHighGEvent.h

@@ -38,16 +38,14 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-@interface MBLAccelerometerBoschLowOrHighGEvent : MBLEvent<MBLDataSample *>
-
-
-#pragma mark - Beta API (Subject to change)
-
 /**
  The BMI160 combines low-g and high-g detection, so below we expose the
  raw registers as a first enabling step.  Over time this will become
  better encapsulated.
  */
+@interface MBLAccelerometerBoschLowOrHighGEvent : MBLEvent<MBLDataSample *>
+
+#pragma mark - Beta API (Subject to change)
 
 /**
  Set to YES if you want low-g events

MetaWear/Classes/Modules/Settings/MBLSettings.h

@@ -58,6 +58,9 @@ typedef NS_ENUM(uint8_t, MBLTransmitPower) {
     MBLTransmitPowerMinus30dBm = 7
 };
 
+/**
+ Various MetaWear settings and events
+ */
 @interface MBLSettings : MBLModule
 
 /**