lib/kaltura/constants/document.rb in velir_kaltura-ruby-0.4.6 vs lib/kaltura/constants/document.rb in velir_kaltura-ruby-0.4.7

@@ -1,21 +1,39 @@
 module Kaltura
   module Constants
+    ##
+    # The constants module will soon be depreciated into an Enumeration module to
+    # be more in line with the C# API client's namespacing.
+    #
+    # @see Kaltura::Filter::DocumentEntryFilter
+    # @see Kaltura::DocumentEntry
+    ##    
     module Document
+      ##
+      # The constants module will soon be depreciated into an Enumeration module to
+      # be more in line with the C# API client's namespacing.
+      #
+      # @see Kaltura::Filter::DocumentFilter
+      ##
       class OrderBy
-    		NAME_ASC = "+name"
-    		NAME_DESC = "-name"
-    		MODERATION_COUNT_ASC = "+moderationCount"
-    		MODERATION_COUNT_DESC = "-moderationCount"
-    		CREATED_AT_ASC = "+createdAt"
-    		CREATED_AT_DESC = "-createdAt"
-    		RANK_ASC = "+rank"
-    		RANK_DESC = "-rank"
+    		NAME_ASC = "+name" #order by name ascending.
+    		NAME_DESC = "-name" #order by name descending.
+    		MODERATION_COUNT_ASC = "+moderationCount" #order by moderation count ascending.
+    		MODERATION_COUNT_DESC = "-moderationCount" #order by moderation count descending.
+    		CREATED_AT_ASC = "+createdAt" #order by created_at ascending.
+    		CREATED_AT_DESC = "-createdAt" #ordery by created_at descending.
+    		RANK_ASC = "+rank" #order by rank ascending.
+    		RANK_DESC = "-rank" #order by rank descending.
     	end
-    	
+    	##
+      # The constants module will soon be depreciated into an Enumeration module to
+      # be more in line with the C# API client's namespacing.
+      #
+      # @see Kaltura::DocumentEntry
+      ##
     	class Type
-    		DOCUMENT = 11
-    		SWF = 12
+    		DOCUMENT = 11 #Document.
+    		SWF = 12 #Executable Flash file.
     	end
     end
   end
 end
\ No newline at end of file