Changeset 11567 for trunk

Timestamp:

11/03/08 16:48:34 (2 months ago)

Author:

ejhernandez@…

Message:

Documenting public methods as coding styles said so

Files:

• trunk/client/ebox/src/EBox/ProgressIndicator.pm (modified) (3 diffs)

trunk/client/ebox/src/EBox/ProgressIndicator.pm

@@ -166 +166 @@
 }
 
+# Method: percentage
+#
+#     Return how many ticks have been performed of the total in
+#     percentage means
+#
+# Returns:
+#
+#     String - the percentage round to two decimals
+#
 sub percentage
 {
@@ -194 +203 @@
 }
 
+# Method: started
+#
+#     Return whether the action to perform has started or not
+#
+# Returns:
+#
+#     True  - if it has started
+#     False - otherwise
+#
 sub started
 {
@@ -206 +224 @@
 }
 
-
+# Method: finished
+#
+#     Return whether the action to perform has finished or not
+#
+# Returns:
+#
+#     True  - if it has finished
+#     False - otherwise
+#
 sub finished
 {