Change in ovirt-engine-sdk-ruby[master]: Use Yard for documentation

juan.hernandez at redhat.com juan.hernandez at redhat.com
Tue Mar 8 11:21:54 UTC 2016


Juan Hernandez has submitted this change and it was merged.

Change subject: Use Yard for documentation
......................................................................


Use Yard for documentation

Currently the documentation of the SDK is generating using "rdoc", but
it doesn't support AsciiDoc, which is the format used in the API model.
This patch changes the SDK to use Yard, as it does support AsciiDoc.

Change-Id: I1b2137cf1a2afba9b5b5b9a740a53fbbc6c4b551
Signed-off-by: Juan Hernandez <juan.hernandez at redhat.com>
---
M generator/src/main/java/org/ovirt/sdk/ruby/ServicesGenerator.java
M generator/src/main/java/org/ovirt/sdk/ruby/TypesGenerator.java
A generator/src/main/java/org/ovirt/sdk/ruby/YardDoc.java
M packaging/spec.el7.in
M packaging/spec.fc23.in
D sdk/.rdoc_options
A sdk/.yardopts
M sdk/README.adoc
M sdk/lib/ovirtsdk4/http.rb
M sdk/lib/ovirtsdk4/reader.rb
M sdk/lib/ovirtsdk4/service.rb
M sdk/lib/ovirtsdk4/type.rb
M sdk/lib/ovirtsdk4/writer.rb
M sdk/lib/ovirtsdk4/xml.rb
M sdk/ovirt-engine-sdk.gemspec
15 files changed, 254 insertions(+), 216 deletions(-)

Approvals:
  Juan Hernandez: Verified; Looks good to me, approved
  Jenkins CI: Passed CI tests



-- 
To view, visit https://gerrit.ovirt.org/54460
To unsubscribe, visit https://gerrit.ovirt.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I1b2137cf1a2afba9b5b5b9a740a53fbbc6c4b551
Gerrit-PatchSet: 1
Gerrit-Project: ovirt-engine-sdk-ruby
Gerrit-Branch: master
Gerrit-Owner: Juan Hernandez <juan.hernandez at redhat.com>
Gerrit-Reviewer: Jenkins CI
Gerrit-Reviewer: Juan Hernandez <juan.hernandez at redhat.com>
Gerrit-Reviewer: gerrit-hooks <automation at ovirt.org>



More information about the Engine-commits mailing list