aspose_words_cloud 20.10.0 → 20.11.0

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

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for search operation.
   #
   class SearchRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # The regular expression used to find matches.
@@ -49,7 +49,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param pattern The regular expression used to find matches.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for split_document operation.
   #
   class SplitDocumentRequest
-    # Original document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Format to split.
+    # The format to split.
     attr_accessor :format
 
     # Original document folder.
@@ -50,13 +50,13 @@ module AsposeWordsCloud
     # Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
     attr_accessor :dest_file_name
 
-    # Start page.
+    # The start page.
     attr_accessor :from
 
-    # End page.
+    # The end page.
     attr_accessor :to
 
-    # ZipOutput or not.
+    # The flag indicating whether to ZIP the output.
     attr_accessor :zip_output
 
     # Folder in filestorage with custom fonts.
@@ -64,16 +64,16 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name Original document name.
-    # @param format Format to split.
+    # @param name The filename of the input document.
+    # @param format The format to split.
     # @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 dest_file_name Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
-    # @param from Start page.
-    # @param to End page.
-    # @param zip_output ZipOutput or not.
+    # @param from The start page.
+    # @param to The end page.
+    # @param zip_output The flag indicating whether to ZIP the output.
     # @param fonts_location Folder in filestorage with custom fonts.
 
     def initialize(name, format, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, from = nil, to = nil, zip_output = nil, fonts_location = nil)

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

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for unprotect_document operation.
   #
   class UnprotectDocumentRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # ProtectionRequest with protection settings.
+    # The protection settings.
     attr_accessor :protection_request
 
     # Original document folder.
@@ -52,8 +52,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param protection_request ProtectionRequest with protection settings.
+    # @param name The filename of the input document.
+    # @param protection_request The protection settings.
     # @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/update_bookmark_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for update_bookmark operation.
   #
   class UpdateBookmarkRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # BookmarkData with new bookmark data.
+    # The properties of the bookmark.
     attr_accessor :bookmark_data
 
-    # The bookmark name.
+    # The name of the bookmark.
     attr_accessor :bookmark_name
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param bookmark_data BookmarkData with new bookmark data.
-    # @param bookmark_name The bookmark name.
+    # @param name The filename of the input document.
+    # @param bookmark_data The properties of the bookmark.
+    # @param bookmark_name The name of the bookmark.
     # @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/update_border_request.rb

@@ -29,16 +29,16 @@ module AsposeWordsCloud
   # Request model for update_border operation.
   #
   class UpdateBorderRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Border properties.
+    # The new border properties to update.
     attr_accessor :border_properties
 
     # Border type.
     attr_accessor :border_type
 
-    # Path to the node with border(node should be paragraph, cell or row).
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -64,10 +64,10 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param border_properties Border properties.
+    # @param name The filename of the input document.
+    # @param border_properties The new border properties to update.
     # @param border_type Border type.
-    # @param node_path Path to the node with border(node should be paragraph, cell or row).
+    # @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/update_comment_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for update_comment operation.
   #
   class UpdateCommentRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # The comment index.
+    # The index of the comment.
     attr_accessor :comment_index
 
-    # The comment data.
+    # The properties of the comment.
     attr_accessor :comment
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param comment_index The comment index.
-    # @param comment The comment data.
+    # @param name The filename of the input document.
+    # @param comment_index The index of the comment.
+    # @param comment The properties of the comment.
     # @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/update_drawing_object_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for update_drawing_object operation.
   #
   class UpdateDrawingObjectRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Drawing object parameters.
@@ -41,7 +41,7 @@ module AsposeWordsCloud
     # 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.
@@ -67,11 +67,11 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param drawing_object Drawing object parameters.
     # @param image_file File with image.
     # @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/update_field_request.rb

@@ -29,16 +29,16 @@ module AsposeWordsCloud
   # Request model for update_field operation.
   #
   class UpdateFieldRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Field data.
+    # The properties of the field.
     attr_accessor :field
 
     # 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.
@@ -64,10 +64,10 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param field Field data.
+    # @param name The filename of the input document.
+    # @param field The properties of the field.
     # @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/update_fields_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for update_fields operation.
   #
   class UpdateFieldsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -49,7 +49,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/update_footnote_request.rb

@@ -29,16 +29,16 @@ module AsposeWordsCloud
   # Request model for update_footnote operation.
   #
   class UpdateFootnoteRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Footnote data.
+    # The properties of the footnote.
     attr_accessor :footnote_dto
 
     # 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.
@@ -64,10 +64,10 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param footnote_dto Footnote data.
+    # @param name The filename of the input document.
+    # @param footnote_dto The properties of the footnote.
     # @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.

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

@@ -29,16 +29,16 @@ module AsposeWordsCloud
   # Request model for update_form_field operation.
   #
   class UpdateFormFieldRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # From field data.
+    # The new form field properties.
     attr_accessor :form_field
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node that contains collection of formfields.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -64,10 +64,10 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param form_field From field data.
+    # @param name The filename of the input document.
+    # @param form_field The new form field properties.
     # @param index Object index.
-    # @param node_path Path to the node that contains collection of formfields.
+    # @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/update_list_level_request.rb

@@ -29,16 +29,16 @@ module AsposeWordsCloud
   # Request model for update_list_level operation.
   #
   class UpdateListLevelRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # List object.
+    # The properties of the List element.
     attr_accessor :list_update
 
-    # List unique identifier.
+    # The list Id.
     attr_accessor :list_id
 
-    # List level identifier.
+    # The list level.
     attr_accessor :list_level
 
     # Original document folder.
@@ -64,10 +64,10 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param list_update List object.
-    # @param list_id List unique identifier.
-    # @param list_level List level identifier.
+    # @param name The filename of the input document.
+    # @param list_update The properties of the List element.
+    # @param list_id The list Id.
+    # @param list_level The list level.
     # @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/update_list_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for update_list operation.
   #
   class UpdateListRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # List object.
+    # The properties of the list.
     attr_accessor :list_update
 
-    # List unique identifier.
+    # The list Id.
     attr_accessor :list_id
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param list_update List object.
-    # @param list_id List unique identifier.
+    # @param name The filename of the input document.
+    # @param list_update The properties of the list.
+    # @param list_id The list Id.
     # @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/update_paragraph_format_request.rb

@@ -29,16 +29,16 @@ module AsposeWordsCloud
   # Request model for update_paragraph_format operation.
   #
   class UpdateParagraphFormatRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Paragraph format object.
+    # The formatting properties of a paragraph.
     attr_accessor :dto
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node which contains paragraphs.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -64,10 +64,10 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param dto Paragraph format object.
+    # @param name The filename of the input document.
+    # @param dto The formatting properties of a paragraph.
     # @param index Object index.
-    # @param node_path Path to the node which contains paragraphs.
+    # @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/update_paragraph_list_format_request.rb

@@ -29,16 +29,16 @@ module AsposeWordsCloud
   # Request model for update_paragraph_list_format operation.
   #
   class UpdateParagraphListFormatRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Paragraph format object.
+    # The formatting properties of a paragraph list.
     attr_accessor :dto
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node which contains paragraphs.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -64,10 +64,10 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param dto Paragraph format object.
+    # @param name The filename of the input document.
+    # @param dto The formatting properties of a paragraph list.
     # @param index Object index.
-    # @param node_path Path to the node which contains paragraphs.
+    # @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.