diff options
author | Leon Breedt <bitserf@gmail.com> | 2005-06-25 18:57:33 +0000 |
---|---|---|
committer | Leon Breedt <bitserf@gmail.com> | 2005-06-25 18:57:33 +0000 |
commit | 1b07366c2fc12dcd38c1498e3239beb03103a09e (patch) | |
tree | 2f04459698abf2c8edd1bf413df2975ecdc51878 /actionwebservice/lib/action_web_service/api.rb | |
parent | 07f237bdae9051cfc5bd38d7608f7a63de54e01b (diff) | |
download | rails-1b07366c2fc12dcd38c1498e3239beb03103a09e.tar.gz rails-1b07366c2fc12dcd38c1498e3239beb03103a09e.tar.bz2 rails-1b07366c2fc12dcd38c1498e3239beb03103a09e.zip |
add RDoc for base signature types
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@1512 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'actionwebservice/lib/action_web_service/api.rb')
-rw-r--r-- | actionwebservice/lib/action_web_service/api.rb | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/actionwebservice/lib/action_web_service/api.rb b/actionwebservice/lib/action_web_service/api.rb index 7db921b4a0..baf7856c6c 100644 --- a/actionwebservice/lib/action_web_service/api.rb +++ b/actionwebservice/lib/action_web_service/api.rb @@ -8,7 +8,11 @@ module ActionWebService # :nodoc: # # It is attached to web service implementation classes like # ActionWebService::Base and ActionController::Base derivatives by using - # ClassMethods#web_service_api. + # <tt>container.web_service_api</tt>, where <tt>container</tt> is an + # ActionController::Base or a ActionWebService::Base. + # + # See ActionWebService::Container::Direct::ClassMethods for an example + # of use. class Base # Whether to transform the public API method names into camel-cased names class_inheritable_option :inflect_names, true @@ -40,7 +44,7 @@ module ActionWebService # :nodoc: # A parameter specifier can be one of the following: # # * A symbol or string of representing one of the Action Web Service base types. - # See ActionWebService::Signature for a canonical list of the base types. + # See ActionWebService::SignatureTypes for a canonical list of the base types. # * The Class object of the parameter type # * A single-element Array containing one of the two preceding items. This # will cause Action Web Service to treat the parameter at that position |