diff options
| -rw-r--r-- | .yardopts | 4 | ||||
| -rw-r--r-- | README.md (renamed from README.markdown) | 9 | ||||
| -rw-r--r-- | lib/authorization.rb | 2 |
3 files changed, 10 insertions, 5 deletions
diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..cef1332 --- /dev/null +++ b/.yardopts @@ -0,0 +1,4 @@ +--readme README +--title 'Thin Ruby wrapper for the OpenTox REST API' +--charset utf-8 +yardoc lib/*.rb - README ChangeLog VERSION LICENSE diff --git a/README.markdown b/README.md index 47f9c70..91889ec 100644 --- a/README.markdown +++ b/README.md @@ -28,10 +28,11 @@ Installation gem install opentox-client -[API documentation](http://rdoc.info/gems/opentox-client) -------------------------------------------------------------------- +Documentation +------------- +* [API documentation](http://rdoc.info/gems/opentox-client) +* [RubyDoc.info Code documentation](http://rubydoc.info/github/opentox/opentox-client/development/frames) Copyright --------- - -Copyright (c) 2009-2012 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. +Copyright (c) 2009-2014 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. diff --git a/lib/authorization.rb b/lib/authorization.rb index 3884d8e..0502b37 100644 --- a/lib/authorization.rb +++ b/lib/authorization.rb @@ -64,7 +64,7 @@ module OpenTox #Authentication against OpenSSO. Returns token. Requires Username and Password. # @param user [String] Username # @param pw [String] Password - # @return [String, nil] gives subjectid or nil + # @return [Boolean] true if successful def self.authenticate(user, pw) return nil if !AA begin |