From 52d7fa12e3474c425c6caf5830427f12195b6c14 Mon Sep 17 00:00:00 2001 From: rautenberg Date: Tue, 25 Feb 2014 09:58:30 +0100 Subject: Update yard documentation, set link to RubyDoc.info --- README.markdown | 8 +++++--- 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 -- cgit v1.2.3 From 762617e92dbbd6116fd92ad10a936ae87deab7ea Mon Sep 17 00:00:00 2001 From: rautenberg Date: Tue, 25 Feb 2014 10:01:01 +0100 Subject: Update yard documentationo --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.markdown b/README.markdown index 353f01f..0fee183 100644 --- a/README.markdown +++ b/README.markdown @@ -31,7 +31,7 @@ Installation Documentation ------------- * [API documentation](http://rdoc.info/gems/opentox-client) -* [RubyDoc Code documentation](http://rubydoc.info/github/opentox/opentox-client/development/frames) +* [RubyDoc.info Code documentation](http://rubydoc.info/github/opentox/opentox-client/development/frames) Copyright --------- -- cgit v1.2.3 From 70c7b3496b7cb81b55607d8e358424cbac7a2390 Mon Sep 17 00:00:00 2001 From: rautenberg Date: Tue, 25 Feb 2014 10:23:02 +0100 Subject: test webhook for rubydoc --- README.markdown | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.markdown b/README.markdown index 0fee183..cd91c81 100644 --- a/README.markdown +++ b/README.markdown @@ -37,3 +37,5 @@ Copyright --------- Copyright (c) 2009-2014 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. + +x \ No newline at end of file -- cgit v1.2.3 From 94bc82ec09942b4b095302636ba996224a368586 Mon Sep 17 00:00:00 2001 From: rautenberg Date: Tue, 25 Feb 2014 10:25:30 +0100 Subject: test webhook for rubydoc --- README.markdown | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.markdown b/README.markdown index cd91c81..70760ae 100644 --- a/README.markdown +++ b/README.markdown @@ -1,7 +1,7 @@ opentox-client ==================== -Thin Ruby wrapper for the [OpenTox](http://www.opentox.org) REST API +Thin Ruby wrapper for the [OpenTox](http://www.opentox.org) REST API. Libraries: @@ -35,7 +35,4 @@ Documentation Copyright --------- - Copyright (c) 2009-2014 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. - -x \ No newline at end of file -- cgit v1.2.3 From ad1d6a4a7c0939b7c27869563d74809288de2b97 Mon Sep 17 00:00:00 2001 From: rautenberg Date: Tue, 25 Feb 2014 10:29:29 +0100 Subject: add .yardopts, mv README.markdown to README.md --- .yardopts | 4 ++++ README.markdown | 38 -------------------------------------- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 42 insertions(+), 38 deletions(-) create mode 100644 .yardopts delete mode 100644 README.markdown create mode 100644 README.md 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.markdown deleted file mode 100644 index 70760ae..0000000 --- a/README.markdown +++ /dev/null @@ -1,38 +0,0 @@ -opentox-client -==================== - -Thin Ruby wrapper for the [OpenTox](http://www.opentox.org) REST API. - -Libraries: - -* {OpenTox::Algorithm} Wrapper for OpenTox Algorithms -* {OpenTox::Authorization} Authorization and Authentication -* {OpenTox::Compound} Compound Library -* {OpenTox::Dataset} Dataset Library -* {OpenTox::Error} extends Exception class according the OpenTox API -* {OpenTox::Model} Model Library -* {OpenTox} OpenTox Library - general definition of OpenTox objects -* {OTLogger} OpenTox Logger Extensions -* {OpenTox::Policies} parse and serialize XML for the openSSO A&A server -* {OpenTox::RestClientWrapper} wrapper for the RestClient gem -* {OpenTox::Task} Task Library - - -Dependencies ------------- - - libraptor1-dev - -Installation ------------- - - gem install 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-2014 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. diff --git a/README.md b/README.md new file mode 100644 index 0000000..70760ae --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +opentox-client +==================== + +Thin Ruby wrapper for the [OpenTox](http://www.opentox.org) REST API. + +Libraries: + +* {OpenTox::Algorithm} Wrapper for OpenTox Algorithms +* {OpenTox::Authorization} Authorization and Authentication +* {OpenTox::Compound} Compound Library +* {OpenTox::Dataset} Dataset Library +* {OpenTox::Error} extends Exception class according the OpenTox API +* {OpenTox::Model} Model Library +* {OpenTox} OpenTox Library - general definition of OpenTox objects +* {OTLogger} OpenTox Logger Extensions +* {OpenTox::Policies} parse and serialize XML for the openSSO A&A server +* {OpenTox::RestClientWrapper} wrapper for the RestClient gem +* {OpenTox::Task} Task Library + + +Dependencies +------------ + + libraptor1-dev + +Installation +------------ + + gem install 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-2014 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. -- cgit v1.2.3 From b399e6c349e4cc6b5cc88991349eb1e180336721 Mon Sep 17 00:00:00 2001 From: rautenberg Date: Tue, 25 Feb 2014 10:31:35 +0100 Subject: add .yardopts, mv README.markdown to README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 70760ae..91889ec 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ opentox-client ==================== -Thin Ruby wrapper for the [OpenTox](http://www.opentox.org) REST API. +Thin Ruby wrapper for the [OpenTox](http://www.opentox.org) REST API Libraries: -- cgit v1.2.3