Permalink
Browse files

Add experimental tags to waiter methods

  • Loading branch information...
lsegal committed Feb 27, 2014
1 parent da1ca8e commit edbc3e084a996df4650a439d62619c47260645e2
Showing with 3 additions and 0 deletions.
  1. +3 −0 doc-src/templates/api-versions/plugin.rb
@@ -21,6 +21,7 @@ class WaiterObject < YARD::CodeObjects::Base
attr_accessor :operation
def parameters; [] end
+ def property_type; 'function' end
def sep; '$waiter$' end
def title; name.to_s end
end
@@ -96,6 +97,7 @@ def add_waiters(service, klass, model)
is either in its final state or the waiter has timed out and stopped polling
for the final state.
+@api experimental
@param state [String] the resource state to wait for. Available states for this
service are listed in "Waiter Resource States" below.
@param params [map] a list of parameters for the given state. See each waiter
@@ -122,6 +124,7 @@ def add_waiters(service, klass, model)
{#{operation_name}} operation every #{config['interval']} seconds
(at most #{config['maxAttempts']} times).
+@api experimental
@callback (see #{obj.operation.path})
@param (see #{obj.operation.path})
@return (see #{obj.operation.path})

0 comments on commit edbc3e0

Please sign in to comment.