diff options
| author | rautenberg <rautenberg@in-silico.ch> | 2014-02-25 09:58:30 +0100 |
|---|---|---|
| committer | rautenberg <rautenberg@in-silico.ch> | 2014-02-25 09:58:30 +0100 |
| commit | 52d7fa12e3474c425c6caf5830427f12195b6c14 (patch) | |
| tree | 4bc673370054cb13e27d41667c364e1c1008ff66 | |
| parent | 77f61a98a61719ceaf9507723a3fe84a7e0dc925 (diff) | |
Update yard documentation, set link to RubyDoc.info
| -rw-r--r-- | README.markdown | 8 | ||||
| -rw-r--r-- | lib/authorization.rb | 2 |
2 files changed, 6 insertions, 4 deletions
diff --git a/README.markdown b/README.markdown index 47f9c70..353f01f 100644 --- a/README.markdown +++ b/README.markdown @@ -28,10 +28,12 @@ Installation gem install opentox-client -[API documentation](http://rdoc.info/gems/opentox-client) -------------------------------------------------------------------- +Documentation +------------- +* [API documentation](http://rdoc.info/gems/opentox-client) +* [RubyDoc 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 |