Update podspec description.

auth0 · Oct 1, 2014 · 4c1d53c · 4c1d53c
1 parent efcff81
commit 4c1d53c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/JWTDecode.podspec b/JWTDecode.podspec
@@ -3,7 +3,7 @@ Pod::Spec.new do |s|
   s.version          = "0.1.0"
   s.summary          = "A JSON Web Token decoder for iOS"
   s.description      = <<-DESC
-                        A JSON Web Token decoder for iOS
+                        A Simple JSON Web Token decoder for iOS.
                         DESC
   s.homepage         = "https://github.com/auth0/JWTDecode.iOS"
   s.license          = 'MIT'

diff --git a/Pod/Classes/A0JWTDecoder.h b/Pod/Classes/A0JWTDecoder.h
@@ -24,6 +24,15 @@
 
 @interface A0JWTDecoder : NSObject
 
+/**
+ *  Decode and parse the JWT token and returns a `NSDate` with the expiration date of the JSON WebToken.
+ *  If there is an error when parsing the JWT, the parameter `error` will have the failure reason.
+ *
+ *  @param jwt   a JWT Token
+ *  @param error NSError if the decode fails
+ *
+ *  @return the expire date or nil if an error ocurrs.
+ */
 + (NSDate *)expireDateOfJWT:(NSString *)jwt error:(NSError **)error;
 
 @end