mirror of
https://github.com/OpenNebula/one.git
synced 2026-11-19 03:12:55 +09:00
bug #1833: fix documentation bugs
This commit is contained in:
1 parent
1f6e24c52d
commit
bc5396129a
6 files changed
+10
-13
No files matched your search
@@ -69,7 +69,7 @@ module OpenNebula
|
||||
|
||||
# Constructor
|
||||
#
|
||||
# @param xml [String] must be an xml built with {#build_xml}
|
||||
# @param xml [String] must be an xml built with {.build_xml}
|
||||
# @param client [Client] represents an XML-RPC connection
|
||||
def initialize(xml, client)
|
||||
super(xml,client)
|
||||
@@ -79,7 +79,6 @@ module OpenNebula
|
||||
# specified.
|
||||
#
|
||||
# @param pe_id [Integer] rule ID
|
||||
# @param client [Client] represents an XML-RPC connection
|
||||
#
|
||||
# @return [String] an empty XML representation
|
||||
def self.build_xml(pe_id=nil)
|
||||
|
||||
@@ -87,7 +87,7 @@ module OpenNebula
|
||||
# @param hostname [String] Name of the new Host.
|
||||
# @param im [String] Name of the im_driver (information/monitoring)
|
||||
# @param vmm [String] Name of the vmm_driver (hypervisor)
|
||||
# @param tm [String] Name of the vnm_driver (networking)
|
||||
# @param vnm [String] Name of the vnm_driver (networking)
|
||||
# @param cluster_id [String] Id of the cluster
|
||||
#
|
||||
# @return [Integer, OpenNebula::Error] the new ID in case of
|
||||
|
||||
@@ -62,7 +62,6 @@ module OpenNebula
|
||||
#
|
||||
# @param [String] xml_method the name of the XML-RPC method
|
||||
# @param [String] root_element Base XML element name
|
||||
# @param [Array] args additional arguments
|
||||
#
|
||||
# @return [nil, OpenNebula::Error] nil in case of success, Error
|
||||
# otherwise
|
||||
@@ -243,9 +242,8 @@ module OpenNebula
|
||||
# @param [String] root_elem Root for each individual PoolElement
|
||||
# @param [String] timestamp_elem Name of the XML element with the last
|
||||
# monitorization timestamp
|
||||
# @param [Integer] Id of the object to process
|
||||
# @param [Integer] oid Id of the object to process
|
||||
# @param [Array<String>] xpath_expressions Elements to retrieve.
|
||||
# @param args arguemnts for the xml_method call
|
||||
#
|
||||
# @return [Hash<String, Array<Array<int>>, OpenNebula::Error] Hash with
|
||||
# the requested xpath expressions, and an Array of [timestamp, value].
|
||||
|
||||
@@ -306,7 +306,7 @@ module OpenNebula
|
||||
|
||||
# Detaches a NIC from a running VM
|
||||
#
|
||||
# @param disk_id [Integer] Id of the NIC to be detached
|
||||
# @param nic_id [Integer] Id of the NIC to be detached
|
||||
# @return [nil, OpenNebula::Error] nil in case of success, Error
|
||||
# otherwise
|
||||
def nic_detach(nic_id)
|
||||
|
||||
@@ -57,7 +57,7 @@ EOT
|
||||
# Initialize client instance
|
||||
# @param [String] user oZones username
|
||||
# @param [String] pass oZones password
|
||||
# @param [String] endpoint Server endpoint
|
||||
# @param [String] endpoint_str Server endpoint
|
||||
# @param [Integer] timeout client timout, defaults means no timeout
|
||||
# @param [Boolean] debug_flag produce debug information
|
||||
# @return [Client] Client instance
|
||||
@@ -174,7 +174,7 @@ EOT
|
||||
|
||||
|
||||
# Retrieves a resource
|
||||
# @param [String] Kind resource kind: vdc, zone...
|
||||
# @param [String] kind resource kind: vdc, zone...
|
||||
# @param [#to_i] id resource id
|
||||
# @return [String, Zona::Error] Response string or Error
|
||||
def get_resource(kind, id)
|
||||
@@ -191,9 +191,9 @@ EOT
|
||||
end
|
||||
|
||||
# Retrieves a pool belonging to a specific resource
|
||||
# @param [String] Kind resource kind: vdc, zone...
|
||||
# @param [String] kind resource kind: vdc, zone...
|
||||
# @param [#to_i] id resource id
|
||||
# @param [String] Kind of pool: image, vm, host, etc
|
||||
# @param [String] pool Kind of pool: image, vm, host, etc
|
||||
# @return [String, Zona::Error] Response string or Error
|
||||
def get_resource_pool(kind, id, pool)
|
||||
url = URI.parse("#{@endpoint}/#{kind}/#{id}/#{pool}")
|
||||
@@ -326,7 +326,7 @@ EOT
|
||||
class Error
|
||||
attr_reader :message
|
||||
|
||||
# @param [String] A description of the error
|
||||
# @param [String] message A description of the error
|
||||
def initialize(message=nil)
|
||||
@message=message
|
||||
end
|
||||
|
||||
@@ -24,7 +24,7 @@ module Zona
|
||||
|
||||
# Initializes a Pool instance
|
||||
# @param [#to_sym] pool pool name tag
|
||||
# @param [#to_sym] pool pool elements name tag
|
||||
# @param [#to_sym] element pool elements name tag
|
||||
# @param [Zona::Client] client OZones Client
|
||||
def initialize(pool,element,client)
|
||||
super(nil)
|
||||
|
||||
Reference in new issue
Block a user