aspose_words_cloud 20.10.0 → 20.11.0

data/lib/aspose_words_cloud/models/requests/get_comments_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for get_comments operation.
   #
   class GetCommentsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -46,7 +46,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_by_index_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_document_drawing_object_by_index operation.
   #
   class GetDocumentDrawingObjectByIndexRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node, which contains collection of drawing objects.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -52,9 +52,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param index Object index.
-    # @param node_path Path to the node, which contains collection of drawing objects.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_image_data_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_document_drawing_object_image_data operation.
   #
   class GetDocumentDrawingObjectImageDataRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node, which contains collection of drawing objects.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -52,9 +52,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param index Object index.
-    # @param node_path Path to the node, which contains collection of drawing objects.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_ole_data_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_document_drawing_object_ole_data operation.
   #
   class GetDocumentDrawingObjectOleDataRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node, which contains collection of drawing objects.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -52,9 +52,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param index Object index.
-    # @param node_path Path to the node, which contains collection of drawing objects.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_document_drawing_objects_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_document_drawing_objects operation.
   #
   class GetDocumentDrawingObjectsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to the node, which contains collection of drawing objects.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param node_path Path to the node, which contains collection of drawing objects.
+    # @param name The filename of the input document.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_document_field_names_online_request.rb

@@ -32,13 +32,13 @@ module AsposeWordsCloud
     # File with template.
     attr_accessor :template
 
-    # Use non merge fields or not.
+    # The flag indicating whether to use non merge fields. If true, result includes "mustache" field names.
     attr_accessor :use_non_merge_fields
 
     #
     # Initializes a new instance.
     # @param template File with template.
-    # @param use_non_merge_fields Use non merge fields or not.
+    # @param use_non_merge_fields The flag indicating whether to use non merge fields. If true, result includes "mustache" field names.
 
     def initialize(template, use_non_merge_fields = nil)
       self.template = template

data/lib/aspose_words_cloud/models/requests/get_document_field_names_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for get_document_field_names operation.
   #
   class GetDocumentFieldNamesRequest
-    # The template name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -44,17 +44,17 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # If true, result includes "mustache" field names.
+    # The flag indicating whether to use non merge fields. If true, result includes "mustache" field names.
     attr_accessor :use_non_merge_fields
 
     #
     # Initializes a new instance.
-    # @param name The template name.
+    # @param name The filename of the input document.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
-    # @param use_non_merge_fields If true, result includes "mustache" field names.
+    # @param use_non_merge_fields The flag indicating whether to use non merge fields. If true, result includes "mustache" field names.
 
     def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, use_non_merge_fields = nil)
       self.name = name

data/lib/aspose_words_cloud/models/requests/get_document_hyperlink_by_index_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_document_hyperlink_by_index operation.
   #
   class GetDocumentHyperlinkByIndexRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # The hyperlink index.
+    # The index of the hyperlink.
     attr_accessor :hyperlink_index
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param hyperlink_index The hyperlink index.
+    # @param name The filename of the input document.
+    # @param hyperlink_index The index of the hyperlink.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_document_hyperlinks_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for get_document_hyperlinks operation.
   #
   class GetDocumentHyperlinksRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -46,7 +46,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_document_properties_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for get_document_properties operation.
   #
   class GetDocumentPropertiesRequest
-    # The document's name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -46,7 +46,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document's name.
+    # @param name The filename of the input document.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_document_property_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_document_property operation.
   #
   class GetDocumentPropertyRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # The property name.
+    # The name of the property.
     attr_accessor :property_name
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param property_name The property name.
+    # @param name The filename of the input document.
+    # @param property_name The name of the property.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_document_protection_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for get_document_protection operation.
   #
   class GetDocumentProtectionRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -46,7 +46,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_document_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for get_document operation.
   #
   class GetDocumentRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :document_name
 
     # Original document folder.
@@ -46,7 +46,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param document_name The document name.
+    # @param document_name The filename of the input document.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for get_document_statistics operation.
   #
   class GetDocumentStatisticsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -44,25 +44,25 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # Support including/excluding comments from the WordCount. Default value is "false".
+    # The flag indicating whether to include comments from the WordCount. The default value is "false".
     attr_accessor :include_comments
 
-    # Support including/excluding footnotes from the WordCount. Default value is "false".
+    # The flag indicating whether to include footnotes from the WordCount. The default value is "false".
     attr_accessor :include_footnotes
 
-    # Support including/excluding shape's text from the WordCount. Default value is "false".
+    # The flag indicating whether to include shape's text from the WordCount. The default value is "false".
     attr_accessor :include_text_in_shapes
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
-    # @param include_comments Support including/excluding comments from the WordCount. Default value is "false".
-    # @param include_footnotes Support including/excluding footnotes from the WordCount. Default value is "false".
-    # @param include_text_in_shapes Support including/excluding shape's text from the WordCount. Default value is "false".
+    # @param include_comments The flag indicating whether to include comments from the WordCount. The default value is "false".
+    # @param include_footnotes The flag indicating whether to include footnotes from the WordCount. The default value is "false".
+    # @param include_text_in_shapes The flag indicating whether to include shape's text from the WordCount. The default value is "false".
 
     def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, include_comments = nil, include_footnotes = nil, include_text_in_shapes = nil)
       self.name = name

data/lib/aspose_words_cloud/models/requests/get_document_with_format_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for get_document_with_format operation.
   #
   class GetDocumentWithFormatRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # The destination format.
@@ -47,7 +47,7 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # Path to save the result.
+    # The path to the output document.
     attr_accessor :out_path
 
     # Folder in filestorage with custom fonts.
@@ -55,13 +55,13 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param format The destination format.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
-    # @param out_path Path to save the result.
+    # @param out_path The path to the output document.
     # @param fonts_location Folder in filestorage with custom fonts.
 
     def initialize(name, format, folder = nil, storage = nil, load_encoding = nil, password = nil, out_path = nil, fonts_location = nil)

data/lib/aspose_words_cloud/models/requests/get_field_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_field operation.
   #
   class GetFieldRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node, which contains collection of fields.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -52,9 +52,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param index Object index.
-    # @param node_path Path to the node, which contains collection of fields.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_fields_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_fields operation.
   #
   class GetFieldsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to the node, which contains collection of fields.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param node_path Path to the node, which contains collection of fields.
+    # @param name The filename of the input document.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_footnote_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_footnote operation.
   #
   class GetFootnoteRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node, which contains collection of footnotes.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -52,9 +52,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param index Object index.
-    # @param node_path Path to the node, which contains collection of footnotes.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.