diff --git a/MicroBlink.framework/Headers/PPBaseOverlayViewController.h b/MicroBlink.framework/Headers/PPBaseOverlayViewController.h index 33135af5..c9e276c0 100644 --- a/MicroBlink.framework/Headers/PPBaseOverlayViewController.h +++ b/MicroBlink.framework/Headers/PPBaseOverlayViewController.h @@ -18,11 +18,18 @@ NS_ASSUME_NONNULL_BEGIN PP_CLASS_AVAILABLE_IOS(6.0) @interface PPBaseOverlayViewController : PPOverlayViewController /** - Array with overlay subviews (UIView subclasses implementing the PPOverlaySubview protocol) + * Registers a subview for overlay events. */ - (void)registerOverlaySubview:(UIView*)subview; + +/** + * Unregisters a subview for overlay events. + */ - (void)unregisterOverlaySubview:(UIView*)subview; +/** + * Delegate for subview animation events. + */ @property (nonatomic, weak) id overlaySubviewsDelegate; @end diff --git a/MicroBlink.framework/Headers/PPDecodingInfo.h b/MicroBlink.framework/Headers/PPDecodingInfo.h index 98cf5d23..403c46b3 100644 --- a/MicroBlink.framework/Headers/PPDecodingInfo.h +++ b/MicroBlink.framework/Headers/PPDecodingInfo.h @@ -53,6 +53,9 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPDecodingInfo : NSObject dewarpedHeight:(CGFloat)dewarpedHeight uniqueId:(NSString *)uniqueId NS_DESIGNATED_INITIALIZER; +/** + * Please use designated initializer. + */ - (instancetype)init NS_UNAVAILABLE; @end diff --git a/MicroBlink.framework/Headers/PPDetectorRecognizerSettings.h b/MicroBlink.framework/Headers/PPDetectorRecognizerSettings.h index f85b68d6..069fb8d0 100644 --- a/MicroBlink.framework/Headers/PPDetectorRecognizerSettings.h +++ b/MicroBlink.framework/Headers/PPDetectorRecognizerSettings.h @@ -17,14 +17,21 @@ NS_ASSUME_NONNULL_BEGIN /** - * Settings class for configuring Detector recognizer + * Recognizer class for detector settings (Esentially a weapper around PPDetectorSettings). + * Detector recognizer is used to detect various documents on the image. * - * Detector recognizer is used to detect various documents on the image + * If multiple detectors are needed, please check PPMultiDetectorSettings. */ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPDetectorRecognizerSettings : PPRecognizerSettings +/** + * Initializes the recognizer with desired detector settings. + */ - (instancetype)initWithDetectorSettings:(PPDetectorSettings *)detectorSettings NS_DESIGNATED_INITIALIZER; +/** + * Please use designated initializer. + */ - (instancetype)init NS_UNAVAILABLE; @end diff --git a/MicroBlink.framework/Headers/PPDetectorResult.h b/MicroBlink.framework/Headers/PPDetectorResult.h index b4126812..38675670 100644 --- a/MicroBlink.framework/Headers/PPDetectorResult.h +++ b/MicroBlink.framework/Headers/PPDetectorResult.h @@ -10,9 +10,23 @@ #import "PPDetectionStatus.h" #import "PPMicroBlinkDefines.h" +/** + * Enum for type of detection status. + */ typedef NS_ENUM(NSUInteger, PPDetectionCode) { + /** + * Object detection has failed. + */ PPDetectionCodeFail = 0, + + /** + * Object was detected partially. Only some PhotoPay detectors support this. + */ PPDetectionCodeFallback, + + /** + * Object detection has succeded. + */ PPDetectionCodeSuccess, }; @@ -47,6 +61,9 @@ PP_CLASS_AVAILABLE_IOS(6.0) */ - (instancetype)initWithCode:(PPDetectionCode)code status:(PPDetectionStatus)status NS_DESIGNATED_INITIALIZER; +/** + * Please use designated initializer. + */ - (instancetype)init NS_UNAVAILABLE; @end diff --git a/MicroBlink.framework/Headers/PPDetectorSettings.h b/MicroBlink.framework/Headers/PPDetectorSettings.h index 8852409f..7f45d663 100644 --- a/MicroBlink.framework/Headers/PPDetectorSettings.h +++ b/MicroBlink.framework/Headers/PPDetectorSettings.h @@ -16,11 +16,9 @@ struct DetectorSettingsImpl; typedef struct DetectorSettingsImpl DetectorSettingsImpl; /** - * MicroBlink scanning libraries run detector objects to find objects on image - * - * Each detector is configured with PPDetectorSettings object - * - * This class is common superclass for each of the Detector settings, + * MicroBlink scanning libraries run detector objects to find objects on image. + * Each detector is configured with PPDetectorSettings object. + * This class is common superclass for each of the Detector settings. */ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPDetectorSettings : NSObject @@ -35,6 +33,9 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPDetectorSettings : NSObject */ - (instancetype)initWithSettings:(DetectorSettingsImpl*)settings NS_DESIGNATED_INITIALIZER; +/** + * Please use designated initializer. + */ - (instancetype)init NS_UNAVAILABLE; @end diff --git a/MicroBlink.framework/Headers/PPDocumentDetectorResult.h b/MicroBlink.framework/Headers/PPDocumentDetectorResult.h index f1f143a0..2b2c1b0b 100644 --- a/MicroBlink.framework/Headers/PPDocumentDetectorResult.h +++ b/MicroBlink.framework/Headers/PPDocumentDetectorResult.h @@ -13,18 +13,18 @@ NS_ASSUME_NONNULL_BEGIN /** - * Result of the document detector + * Result of a document detector (used to detector various rectangular objects). */ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPDocumentDetectorResult : PPQuadDetectorResult /** - * Aspect ratio of detected document + * Aspect ratio of detected document. */ @property (nonatomic) CGFloat aspectRatio; /** - * screen orientation used when detecting the document + * Screen orientation used when detecting the document. */ @property (nonatomic) UIInterfaceOrientation screenOrientation; diff --git a/MicroBlink.framework/Headers/PPDocumentSpecification.h b/MicroBlink.framework/Headers/PPDocumentSpecification.h index 134ee532..9deba395 100644 --- a/MicroBlink.framework/Headers/PPDocumentSpecification.h +++ b/MicroBlink.framework/Headers/PPDocumentSpecification.h @@ -84,6 +84,7 @@ typedef NS_ENUM(NSUInteger, PPDocumentPreset) { /** * Document class describes a document which is being detected by DocumentDetector. + * We encurage users to create specifications with one of our presets, if possible. */ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPDocumentSpecification : NSObject diff --git a/MicroBlink.framework/Headers/PPEmailOcrParserFactory.h b/MicroBlink.framework/Headers/PPEmailOcrParserFactory.h index eb9a3199..a867d415 100644 --- a/MicroBlink.framework/Headers/PPEmailOcrParserFactory.h +++ b/MicroBlink.framework/Headers/PPEmailOcrParserFactory.h @@ -9,7 +9,7 @@ #import "PPOcrParserFactory.h" /** - * Parses email addresses + * Parses email addresses. */ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPEmailOcrParserFactory : PPOcrParserFactory diff --git a/MicroBlink.framework/Headers/PPEudlCountry.h b/MicroBlink.framework/Headers/PPEudlCountry.h index 4cda95d8..5a0f0905 100644 --- a/MicroBlink.framework/Headers/PPEudlCountry.h +++ b/MicroBlink.framework/Headers/PPEudlCountry.h @@ -33,6 +33,9 @@ typedef NS_ENUM(NSUInteger, PPEudlCountry) { #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wall" +/** + * Gets the string representation of PPEudlCountry enum. + */ static NSString* eudlCountryToString(PPEudlCountry country) { switch (country) { case PPEudlCountryUnitedKingdom: diff --git a/MicroBlink.framework/Headers/PPImage.h b/MicroBlink.framework/Headers/PPImage.h index 852fcf54..66a22c41 100644 --- a/MicroBlink.framework/Headers/PPImage.h +++ b/MicroBlink.framework/Headers/PPImage.h @@ -12,6 +12,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + * Enum which describes text orientation on an image. + */ typedef NS_ENUM(NSUInteger, PPProcessingOrientation){ /** Text oriented same as picture */ PPProcessingOrientationUp, diff --git a/MicroBlink.framework/Headers/PPImageMetadata.h b/MicroBlink.framework/Headers/PPImageMetadata.h index b8734e5a..b3980de6 100644 --- a/MicroBlink.framework/Headers/PPImageMetadata.h +++ b/MicroBlink.framework/Headers/PPImageMetadata.h @@ -34,7 +34,7 @@ typedef NS_ENUM(NSUInteger, PPImageMetadataType) { /** - * Debug images (and PPDebugMetadata) are only needed if you need to figure out what is not working as expected + * Debug images (and PPDebugMetadata) are only needed if you need to figure out what is not working as expected. */ /** @@ -60,19 +60,38 @@ NS_ASSUME_NONNULL_BEGIN */ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPImageMetadata : PPMetadata +/** + * Orientation with which contained UIImage was processed + */ @property (nonatomic, assign, readonly) UIImageOrientation orientation; +/** + * Type of image returned. + */ @property (nonatomic, readonly) PPImageMetadataType imageType; +/** + * Please use designated initializer. + */ - (instancetype)init NS_UNAVAILABLE; +/** + * Please use designated initializer. + */ - (instancetype)initWithName:(NSString *)name NS_UNAVAILABLE; +/** + * Creates new PPImageMetadata with desired parameters. + */ - (instancetype)initWithName:(NSString *)name orientation:(UIImageOrientation)orientation imageType:(PPImageMetadataType)imageType NS_DESIGNATED_INITIALIZER; -- (UIImage*)image; +/** + * UIImage of returned PPImageMetadata. + * This image is lazy loaded. + */ +- (UIImage *)image; @end diff --git a/MicroBlink.framework/Headers/PPMetadataSettings.h b/MicroBlink.framework/Headers/PPMetadataSettings.h index 2f523576..7a955bba 100644 --- a/MicroBlink.framework/Headers/PPMetadataSettings.h +++ b/MicroBlink.framework/Headers/PPMetadataSettings.h @@ -63,6 +63,10 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPMetadataSettings : NSObject @end +/** + * Settings for debuging various data. + * These settings can help you understand why something isn't working as expected. + */ @interface PPDebugMetadata : NSObject /** diff --git a/MicroBlink.framework/Headers/PPMrtdDetectorSettings.h b/MicroBlink.framework/Headers/PPMrtdDetectorSettings.h index 366f7001..7ac5f9f6 100644 --- a/MicroBlink.framework/Headers/PPMrtdDetectorSettings.h +++ b/MicroBlink.framework/Headers/PPMrtdDetectorSettings.h @@ -41,7 +41,9 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPMrtdDetectorSettings : PPQuadDetectorSe */ - (instancetype)init; -// Unavailable initializer from superclass +/** + * Unavailable initializer from superclass + */ - (instancetype)initWithSettings:(DetectorSettingsImpl*)settings NS_UNAVAILABLE; /** diff --git a/MicroBlink.framework/Headers/PPMyKadRecognizerResult.h b/MicroBlink.framework/Headers/PPMyKadRecognizerResult.h index 140c0318..6c9ad263 100644 --- a/MicroBlink.framework/Headers/PPMyKadRecognizerResult.h +++ b/MicroBlink.framework/Headers/PPMyKadRecognizerResult.h @@ -10,6 +10,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + * Result of scanning MyKad (Malaysian ID document). + */ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPMyKadRecognizerResult : PPRecognizerResult /** diff --git a/MicroBlink.framework/Headers/PPOcrParserFactory.h b/MicroBlink.framework/Headers/PPOcrParserFactory.h index 394c5686..f316639b 100644 --- a/MicroBlink.framework/Headers/PPOcrParserFactory.h +++ b/MicroBlink.framework/Headers/PPOcrParserFactory.h @@ -19,8 +19,14 @@ typedef struct OcrParserFactoryImpl OcrParserFactoryImpl; */ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPOcrParserFactory : NSObject +/** + * Internal parser factory. + */ @property (nonatomic, readonly, assign) OcrParserFactoryImpl *factory; +/** + * Internal initializer. Please use default initializer. + */ - (instancetype)initWithFactory:(struct OcrParserFactoryImpl *)factory; /** diff --git a/MicroBlink.framework/Headers/PPOverlaySubview.h b/MicroBlink.framework/Headers/PPOverlaySubview.h index 36098aa6..441ea257 100644 --- a/MicroBlink.framework/Headers/PPOverlaySubview.h +++ b/MicroBlink.framework/Headers/PPOverlaySubview.h @@ -138,6 +138,9 @@ NS_ASSUME_NONNULL_BEGIN PP_CLASS_AVAILABLE_IOS(6.0) @interface PPOverlaySubview : UIView +/** + * Sorts an array of CGPoint objects + */ - (NSArray*)sortedPoints:(NSArray*)points; @end diff --git a/MicroBlink.framework/Headers/PPOverlayViewController.h b/MicroBlink.framework/Headers/PPOverlayViewController.h index a7699d79..39f55ac9 100644 --- a/MicroBlink.framework/Headers/PPOverlayViewController.h +++ b/MicroBlink.framework/Headers/PPOverlayViewController.h @@ -21,8 +21,6 @@ NS_ASSUME_NONNULL_BEGIN @class PPMetadata; @class PPRecognizerResult; -//@protocol PPOverlayContainerViewController; - /** Overlay View Controller is an abstract class for all overlay views placed on top PhotoPay's Camera View Controller. @@ -180,6 +178,9 @@ PP_CLASS_AVAILABLE_IOS(6.0) - (void)cameraViewController:(UIViewController*)cameraViewController didPublishProgress:(CGFloat)progress; +/** + * Camera view reports the start of detection cycle. + */ - (void)cameraViewControllerDidStartDetection:(UIViewController *)cameraViewController; /** diff --git a/MicroBlink.framework/Headers/PPPointsDetectorResult.h b/MicroBlink.framework/Headers/PPPointsDetectorResult.h index 2683193c..6a192064 100644 --- a/MicroBlink.framework/Headers/PPPointsDetectorResult.h +++ b/MicroBlink.framework/Headers/PPPointsDetectorResult.h @@ -17,7 +17,7 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPPointsDetectorResult : PPDetectorResult /** - * Coordinates of points of a detected object + * Coordinates of points (CGPoint) of a detected object. */ @property (nonatomic) NSArray *points; diff --git a/MicroBlink.framework/Headers/PPPriceOcrParserFactory.h b/MicroBlink.framework/Headers/PPPriceOcrParserFactory.h index cb4bc4a7..7d2060bc 100644 --- a/MicroBlink.framework/Headers/PPPriceOcrParserFactory.h +++ b/MicroBlink.framework/Headers/PPPriceOcrParserFactory.h @@ -9,7 +9,7 @@ #import "PPOcrParserFactory.h" /** - * Parses transaction amount on invoices + * Parses various transaction amount formats on invoices. */ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPPriceOcrParserFactory : PPOcrParserFactory diff --git a/MicroBlink.framework/Headers/PPQuadDetectorResult.h b/MicroBlink.framework/Headers/PPQuadDetectorResult.h index a5735c9e..c1d0d8c7 100644 --- a/MicroBlink.framework/Headers/PPQuadDetectorResult.h +++ b/MicroBlink.framework/Headers/PPQuadDetectorResult.h @@ -13,13 +13,15 @@ NS_ASSUME_NONNULL_BEGIN /** - * Result of the detection of a Quad detector + * Result of the detection of a Quad detector. + * Quad results are results of detecting various rectangular objects. */ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPQuadDetectorResult : PPDetectorResult /** - * Exact location of detected object on image + * Exact location of detected object on image. + * Contains 4 points of detected object's corners. */ @property (nonatomic) PPQuadrangle* detectionLocation; diff --git a/MicroBlink.framework/Headers/PPQuadrangle.h b/MicroBlink.framework/Headers/PPQuadrangle.h index 4f761213..d949c56f 100644 --- a/MicroBlink.framework/Headers/PPQuadrangle.h +++ b/MicroBlink.framework/Headers/PPQuadrangle.h @@ -54,6 +54,9 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPQuadrangle : NSObject */ - (NSArray *)toPointsArray; +/** + * Creates new quadrangle from this quadrangle, transformed by specified affine transformation. + */ - (instancetype)quadrangleWithTransformation:(CGAffineTransform)transform; @end diff --git a/MicroBlink.framework/Headers/PPTemplatingRecognizerSettings.h b/MicroBlink.framework/Headers/PPTemplatingRecognizerSettings.h index 212771c2..5c859371 100644 --- a/MicroBlink.framework/Headers/PPTemplatingRecognizerSettings.h +++ b/MicroBlink.framework/Headers/PPTemplatingRecognizerSettings.h @@ -23,6 +23,9 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPTemplatingRecognizerSettings : PPRecogn * Adds OCR parser. Parser results will be fetched by parser name. * * Parsers added this way are added to default group. + * + * @param factory Parser to be added + * @param name ID of the parser to be added. Output of this parser can be fetched by this name */ - (void)addOcrParser:(PPOcrParserFactory *)factory name:(NSString *)name; @@ -35,6 +38,10 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPTemplatingRecognizerSettings : PPRecogn * and parsers with different character sets in different groups (i.e. amount parser and email parser). * * If using Templating API, parser groups also denote which parsers will be used for specific PPDecodingInfo (group name and uniqueId have to be same). + * + * @param factory Parser to be added + * @param name Name/ID of the parser to be added. Output of this parser can be fetched by this name + * @param group Group name/ID of the parser to be added */ - (void)addOcrParser:(PPOcrParserFactory *)factory name:(NSString *)name @@ -42,16 +49,23 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPTemplatingRecognizerSettings : PPRecogn /** * Removes parser with given name. + * + * @param name Name/ID of the parser to be removed */ - (void)removeOcrParserWithName:(NSString *)name; /** * Removes parser with given name from group. + * + * @param name Name/ID of the parser to be removed + * @param group Group name/ID of the parser to be removed */ - (void)removeOcrParserWithName:(NSString *)parser fromGroup:(NSString *)group; /** * Removes all parsers from a given group. + * + * @param Group name/ID in which all parsers will be removed */ - (void)clearParsersInGroup:(NSString *)group; @@ -62,11 +76,18 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPTemplatingRecognizerSettings : PPRecogn /** * Sets array of PPDecodingInfo to be used when PPDocumentClassifer outputs a selected result. + * + * @see PPDocumentClassifier + * + * @param decodingInfos Decoding infos to be used when PPDocumentClassifier outputs selected result + * @param classifierResult Output from PPDocumentClassifer */ - (void)setDecodingInfoSet:(NSArray *)decodingInfos forClassifierResult:(NSString *)classifierResult; /** * Removes all decoding infos for a given classifier result. + * + * @param classifierResult Removes all decoding infos linked to specified classifier result */ - (void)removeDecodingInfoSetForClassifierResult:(NSString *)classifierResult; diff --git a/MicroBlink.framework/Headers/PPTextMetadata.h b/MicroBlink.framework/Headers/PPTextMetadata.h index 04874786..a917ad71 100644 --- a/MicroBlink.framework/Headers/PPTextMetadata.h +++ b/MicroBlink.framework/Headers/PPTextMetadata.h @@ -37,8 +37,14 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPTextMetadata : PPMetadata */ @property (nonatomic, assign) PPTextMetadataType type; +/** + * Please use one available initializers + */ - (instancetype)init NS_UNAVAILABLE; +/** + * Please use one available initializers + */ - (instancetype)initWithName:(NSString *)name NS_UNAVAILABLE; /** diff --git a/MicroBlink.framework/Headers/PPUsdlRecognizerResult.h b/MicroBlink.framework/Headers/PPUsdlRecognizerResult.h index 49d577ea..8dabfddf 100644 --- a/MicroBlink.framework/Headers/PPUsdlRecognizerResult.h +++ b/MicroBlink.framework/Headers/PPUsdlRecognizerResult.h @@ -950,8 +950,18 @@ PP_CLASS_AVAILABLE_IOS(6.0) @interface PPUsdlRecognizerResult : PPRecognizerResu */ - (NSString *)getField:(const NSString *)key; +/** + * Returns all possible USDL keys with their descriptions. + * + * @return NSDictionary with USDL key - description pairs + */ + (NSDictionary*)descriptionKeys; +/** + * Returns all possible USDL keys ordered as in this header. + * + * @return Array of all USDL keys ordered as in this header + */ + (NSArray *)orderedKeys; @end