Bug #1833
API documentation bugs
| Status: | Closed | Start date: | 03/26/2013 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: | - | % Done: | 0% | |
| Category: | Documentation | |||
| Target version: | Release 4.0 | |||
| Resolution: | fixed | Pull request: | ||
| Affected Versions: | OpenNebula 4.0 | 
Description
The documentation generator gives these warnings for ruby OCA:
[warn]: @param tag has unknown parameter name: client
    in file `opennebula/acl.rb' near line 85
[warn]: Unknown tag @params in file `opennebula/document_json.rb` near line 62
[warn]: @param tag has unknown parameter name: tm
    in file `opennebula/host.rb' near line 93
[warn]: @param tag has unknown parameter name: args
    in file `opennebula/pool_element.rb' near line 69
[warn]: @param tag has unknown parameter name: Id
    in file `opennebula/pool_element.rb' near line 252
[warn]: @param tag has unknown parameter name: args
    in file `opennebula/pool_element.rb' near line 252
[warn]: @param tag has unknown parameter name: disk_id
    in file `opennebula/virtual_machine.rb' near line 294
[warn]: In file `opennebula/acl.rb':71: Cannot resolve link to
#build_xml from text:
[warn]: ...{#build_xml}...
	And for ruby Zones API:
[warn]: @param tag has unknown parameter name: endpoint
    in file `zona.rb' near line 64
[warn]: @param tag has unknown parameter name: Kind
    in file `zona.rb' near line 180
[warn]: @param tag has unknown parameter name: Kind
    in file `zona.rb' near line 198
[warn]: @param tag has unknown parameter name: Kind
    in file `zona.rb' near line 198
[warn]: @param tag has unknown parameter name: A
    in file `zona.rb' near line 330
[warn]: @param tag has duplicate parameter name: pool
    in file `zona/OZonesPool.rb' near line 29
	Also the Zones API states that it is in version 1.0.
Associated revisions
bug #1833: fix documentation bugs
History
#1
     Updated by Javi Fontan about 8 years ago
    Updated by Javi Fontan about 8 years ago
    - Status changed from New to Closed
- Resolution set to fixed