From bc5396129a4c65fded8a989f396cc509d6d02733 Mon Sep 17 00:00:00 2001 From: Javi Fontan Date: Mon, 6 May 2013 15:37:14 +0200 Subject: [PATCH] bug #1833: fix documentation bugs --- src/oca/ruby/opennebula/acl.rb | 3 +-- src/oca/ruby/opennebula/host.rb | 2 +- src/oca/ruby/opennebula/pool_element.rb | 4 +--- src/oca/ruby/opennebula/virtual_machine.rb | 2 +- src/ozones/Client/lib/zona.rb | 10 +++++----- src/ozones/Client/lib/zona/OZonesPool.rb | 2 +- 6 files changed, 10 insertions(+), 13 deletions(-) diff --git a/src/oca/ruby/opennebula/acl.rb b/src/oca/ruby/opennebula/acl.rb index cfdd153dc0..1051d0ecd9 100644 --- a/src/oca/ruby/opennebula/acl.rb +++ b/src/oca/ruby/opennebula/acl.rb @@ -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) diff --git a/src/oca/ruby/opennebula/host.rb b/src/oca/ruby/opennebula/host.rb index 58fe274c55..2504af2652 100644 --- a/src/oca/ruby/opennebula/host.rb +++ b/src/oca/ruby/opennebula/host.rb @@ -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 diff --git a/src/oca/ruby/opennebula/pool_element.rb b/src/oca/ruby/opennebula/pool_element.rb index a28976f035..2af930d8db 100644 --- a/src/oca/ruby/opennebula/pool_element.rb +++ b/src/oca/ruby/opennebula/pool_element.rb @@ -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] xpath_expressions Elements to retrieve. - # @param args arguemnts for the xml_method call # # @return [Hash>, OpenNebula::Error] Hash with # the requested xpath expressions, and an Array of [timestamp, value]. diff --git a/src/oca/ruby/opennebula/virtual_machine.rb b/src/oca/ruby/opennebula/virtual_machine.rb index dbd4d3a399..c1855c2496 100644 --- a/src/oca/ruby/opennebula/virtual_machine.rb +++ b/src/oca/ruby/opennebula/virtual_machine.rb @@ -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) diff --git a/src/ozones/Client/lib/zona.rb b/src/ozones/Client/lib/zona.rb index 4010b1898d..1128c5ab76 100644 --- a/src/ozones/Client/lib/zona.rb +++ b/src/ozones/Client/lib/zona.rb @@ -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 diff --git a/src/ozones/Client/lib/zona/OZonesPool.rb b/src/ozones/Client/lib/zona/OZonesPool.rb index 59dae5d85d..beea32d201 100644 --- a/src/ozones/Client/lib/zona/OZonesPool.rb +++ b/src/ozones/Client/lib/zona/OZonesPool.rb @@ -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)