diff --git a/EDSemver/EDSemver.h b/EDSemver/EDSemver.h index 9c73e19..f5e239c 100644 --- a/EDSemver/EDSemver.h +++ b/EDSemver/EDSemver.h @@ -8,93 +8,97 @@ #import + +/** + Semantic versioning conforming to [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html) + */ @interface EDSemver : NSObject -/*! - * The major version number (API changes) +/** + The major version number (API changes) */ @property (readonly) NSInteger major; -/*! - * The minor version (functionality added in a backwards compatible manor) +/** + The minor version (functionality added in a backwards compatible manor) */ @property (readonly) NSInteger minor; -/*! - * The patch version (bug fixes made in a backwards compatible manor) +/** + The patch version (bug fixes made in a backwards compatible manor) */ @property (readonly) NSInteger patch; -/*! - * The prerelease number, preceded with -, e.g. 1.2.3-alpha1 +/** + The prerelease number, preceded with -, e.g. 1.2.3-alpha1 */ @property (readonly, nullable) NSString *prerelease; -/*! - * The build number, preceded with +, e.g. 1.2.3+456 +/** + The build number, preceded with +, e.g. 1.2.3+456 */ @property (readonly, nullable) NSString *build; -/*! - * The current semver spec version - * - * @return The spec version as a string +/** + The current semver spec version + + @return The spec version as a string */ + (nonnull NSString *)spec; -/*! - * Create a semver object with a version string - * - * @param aString The version string - * - * @return The semver object +/** + Create a semver object with a version string + + @param aString The version string + + @return The semver object */ + (nonnull instancetype)semverWithString:(nonnull NSString *)aString; -/*! - * Create a semver object with a version string - * - * @param aString The version string - * - * @return The semver object +/** + Create a semver object with a version string + + @param aString The version string + + @return The semver object */ - (nonnull instancetype)initWithString:(nonnull NSString *)aString; -/*! - * Compare semver objects - * - * @param aVersion The version string - * - * @return The semver object +/** + Compare semver objects + + @param aVersion The version string + + @return The semver object */ - (NSComparisonResult)compare:(nonnull EDSemver *)aVersion; -/*! - * Is version equal to another version - * Implemented using `compare:`. Returns NO parameter is nil - * - * @param object Another version - * - * @return YES if equal, NO otherwise +/** + Is version equal to another version + Implemented using `compare:`. Returns `NO` if parameter is `nil` + + @param object Another version + + @return `YES` if equal, `NO` otherwise */ - (BOOL)isEqualTo:(nullable id)object; -/*! - * Is version less than another version. - * Implemented using `compare:`. Returns NO parameter is nil - * - * @param object Another version - * - * @return YES if less than, NO otherwise +/** + Is version less than another version. + Implemented using `compare:`. Returns `NO` if parameter is `nil` + + @param object Another version + + @return `YES` if less than, `NO` otherwise */ - (BOOL)isLessThan:(nullable id)object; -/*! - * Is version greater than than another version. - * Implemented using `compare:`. Returns NO parameter is nil - * - * @param object Another version - * - * @return YES if greater than, NO otherwise +/** + Is version greater than than another version. + Implemented using `compare:`. Returns `NO` if parameter is `nil` + + @param object Another version + + @return `YES` if greater than, `NO` otherwise */ - (BOOL)isGreaterThan:(nullable id)object; -/*! - * Is the semver object valid? - * - * @return YES if valid, NO otherwise +/** + Is the semver object valid? + + @return `YES` if valid, `NO` otherwise */ - (BOOL)isValid; diff --git a/Project/semver.xcodeproj/project.pbxproj b/Project/semver.xcodeproj/project.pbxproj index 5aae8b0..efe18b4 100644 --- a/Project/semver.xcodeproj/project.pbxproj +++ b/Project/semver.xcodeproj/project.pbxproj @@ -381,7 +381,7 @@ attributes = { CLASSPREFIX = ED; LastTestingUpgradeCheck = 0730; - LastUpgradeCheck = 0820; + LastUpgradeCheck = 0930; ORGANIZATIONNAME = "Andrew Sliwinski"; TargetAttributes = { 01DA90111D0ADA5F00D65599 = { @@ -802,11 +802,17 @@ CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; CLANG_CXX_LIBRARY = "libc++"; CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_COMMA = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INFINITE_RECURSION = YES; CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; CLANG_WARN_SUSPICIOUS_MOVE = YES; CLANG_WARN_UNREACHABLE_CODE = YES; CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; @@ -843,11 +849,17 @@ CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; CLANG_CXX_LIBRARY = "libc++"; CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_COMMA = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INFINITE_RECURSION = YES; CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; CLANG_WARN_SUSPICIOUS_MOVE = YES; CLANG_WARN_UNREACHABLE_CODE = YES; CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; diff --git a/Project/semver.xcodeproj/xcshareddata/xcschemes/semver-ios.xcscheme b/Project/semver.xcodeproj/xcshareddata/xcschemes/semver-ios.xcscheme index 16b41c7..069f9cd 100644 --- a/Project/semver.xcodeproj/xcshareddata/xcschemes/semver-ios.xcscheme +++ b/Project/semver.xcodeproj/xcshareddata/xcschemes/semver-ios.xcscheme @@ -1,6 +1,6 @@