Add some more JavaDocs
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/2fb400d4 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/2fb400d4 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/2fb400d4 Branch: refs/heads/qemu-img Commit: 2fb400d4948b1db5fb5630eb978d57967aacab9c Parents: c6f6fce Author: Wido den Hollander <[email protected]> Authored: Fri Feb 22 14:52:21 2013 +0100 Committer: Wido den Hollander <[email protected]> Committed: Fri Feb 22 14:52:21 2013 +0100 ---------------------------------------------------------------------- .../org/apache/cloudstack/utils/qemu/QemuImg.java | 19 ++++++++++++++- 1 files changed, 18 insertions(+), 1 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/2fb400d4/utils/src/org/apache/cloudstack/utils/qemu/QemuImg.java ---------------------------------------------------------------------- diff --git a/utils/src/org/apache/cloudstack/utils/qemu/QemuImg.java b/utils/src/org/apache/cloudstack/utils/qemu/QemuImg.java index b54c9b2..1d7f6d5 100644 --- a/utils/src/org/apache/cloudstack/utils/qemu/QemuImg.java +++ b/utils/src/org/apache/cloudstack/utils/qemu/QemuImg.java @@ -49,6 +49,14 @@ public class QemuImg { } + /** + * Create a QemuImg object + * + * + * @param qemuImgPath + * A alternative path to the qemu-img binary + * @return void + */ public QemuImg(String qemuImgPath) { this._qemuImgPath = qemuImgPath; } @@ -207,7 +215,16 @@ public class QemuImg { this.convert(srcFile, destFile, null); } - /* Commit the changes recorded in filename in its base image */ + /** + * Commit the changes recorded in the file in its base image. + * + * This method calls 'qemu-img commit' and takes one object as + * an argument + * + * @param file + * The file of which changes have to be committed + * @return void + */ public void commit(QemuImgFile file) { }
