Allon Mureinik has uploaded a new change for review. Change subject: core: javadoc ImagesHandler. getSuggestedDiskAlias ......................................................................
core: javadoc ImagesHandler. getSuggestedDiskAlias Improved the documentation of ImagesHandler.getSuggestedDiskAlias, to make it slightly clearer. Change-Id: Ifb41697e19bf63e9897c96007ebda8cfcdbfb2af Signed-off-by: Allon Mureinik <[email protected]> --- M backend/manager/modules/bll/src/main/java/org/ovirt/engine/core/bll/ImagesHandler.java 1 file changed, 12 insertions(+), 7 deletions(-) git pull ssh://gerrit.ovirt.org:29418/ovirt-engine refs/changes/35/9635/1 diff --git a/backend/manager/modules/bll/src/main/java/org/ovirt/engine/core/bll/ImagesHandler.java b/backend/manager/modules/bll/src/main/java/org/ovirt/engine/core/bll/ImagesHandler.java index 0c9a85e..339ea0f 100644 --- a/backend/manager/modules/bll/src/main/java/org/ovirt/engine/core/bll/ImagesHandler.java +++ b/backend/manager/modules/bll/src/main/java/org/ovirt/engine/core/bll/ImagesHandler.java @@ -126,13 +126,18 @@ } /** - * Retrieve disk alias name, if the alias name is null returns the default alias name. - * - * @param disk - * - Disk which disk alias is being initialized in. - * @param diskPrefix - * - The prefix for disk alias if needs to be initialized. - */ + * Suggests an alias for a disk. + * If the disk does not already have an alias, one will be generated for it. + * The generated alias will be formed as prefix_DiskXXX, where XXX is an ordinal. + * + * @param disk + * - The disk that (possibly) requires a new alias + * @param diskPrefix + * - The prefix for the newly generated alias + * @param count + * - The ordinal of disk to create an alias for (first, second, etc.). + * @return The suggested alias + */ public static String getSuggestedDiskAlias(BaseDisk disk, String diskPrefix, int count) { String diskAlias; if (disk == null) { -- To view, visit http://gerrit.ovirt.org/9635 To unsubscribe, visit http://gerrit.ovirt.org/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Ifb41697e19bf63e9897c96007ebda8cfcdbfb2af Gerrit-PatchSet: 1 Gerrit-Project: ovirt-engine Gerrit-Branch: master Gerrit-Owner: Allon Mureinik <[email protected]> _______________________________________________ Engine-patches mailing list [email protected] http://lists.ovirt.org/mailman/listinfo/engine-patches
