Permalink
Browse files

Adding basic yardoc.

  • Loading branch information...
1 parent e862e91 commit 51a4894a7057db765a376cedd8cb25d21b9c6f74 @jfi jfi committed Apr 27, 2012
Showing with 19 additions and 7 deletions.
  1. +2 −0 .gitignore
  2. +1 −0 .yardopts
  3. +13 −0 lib/clockwork/api.rb
  4. +3 −7 lib/clockwork/sms/response.rb
View
@@ -0,0 +1,2 @@
+doc/
+.yardoc/
View
@@ -0,0 +1 @@
+lib/**/*.rb - README.md
View
@@ -1,6 +1,19 @@
+# A wrapper around the Clockwork API.
module Clockwork
+ # @author James Inman <james@mediaburst.co.uk>
+ #
+ # You must create an instance of Clockwork::API to begin using the API.
class API
+
+ # @author James Inman <james
+ # @param [string] api_key API key, 40-character hexadecimal string
+ # @raise Clockwork::InvalidAPIKeyException
+ # Clockwork::API is initialized with an API key, available from http://www.mediaburst.co.uk/api/.
+ def initialize api_key
+ # 40 character [A-F0-9a-f]
+ end
+
end
end
@@ -1,13 +1,9 @@
module Clockwork
-
class SMS
-
class Response
-
-
- end
+
- end
-
+ end
+ end
end

0 comments on commit 51a4894

Please sign in to comment.