aspose_words_cloud 20.10.0 → 20.11.0

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

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for update_run_font operation.
   #
   class UpdateRunFontRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Font dto object.
+    # The font properties of a Run object.
     attr_accessor :font_dto
 
-    # Path to parent paragraph.
+    # The path to the paragraph in the document tree.
     attr_accessor :paragraph_path
 
     # Object index.
@@ -64,9 +64,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param font_dto Font dto object.
-    # @param paragraph_path Path to parent paragraph.
+    # @param name The filename of the input document.
+    # @param font_dto The font properties of a Run object.
+    # @param paragraph_path The path to the paragraph in the document tree.
     # @param index Object index.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for update_run operation.
   #
   class UpdateRunRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Run data.
+    # The properties of the Run object.
     attr_accessor :run
 
-    # Path to parent paragraph.
+    # The path to the paragraph in the document tree.
     attr_accessor :paragraph_path
 
     # Object index.
@@ -64,9 +64,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param run Run data.
-    # @param paragraph_path Path to parent paragraph.
+    # @param name The filename of the input document.
+    # @param run The properties of the Run object.
+    # @param paragraph_path The path to the paragraph in the document tree.
     # @param index Object index.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for update_section_page_setup operation.
   #
   class UpdateSectionPageSetupRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Section index.
+    # The index of the section.
     attr_accessor :section_index
 
-    # Page setup properties dto.
+    # The properties of the page setup.
     attr_accessor :page_setup
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param section_index Section index.
-    # @param page_setup Page setup properties dto.
+    # @param name The filename of the input document.
+    # @param section_index The index of the section.
+    # @param page_setup The properties of the page setup.
     # @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_style_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for update_style operation.
   #
   class UpdateStyleRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Style properties to update.
+    # The properties of the style.
     attr_accessor :style_update
 
-    # Style name.
+    # The name of the style.
     attr_accessor :style_name
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param style_update Style properties to update.
-    # @param style_name Style name.
+    # @param name The filename of the input document.
+    # @param style_update The properties of the style.
+    # @param style_name The name of the style.
     # @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_table_cell_format_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for update_table_cell_format operation.
   #
   class UpdateTableCellFormatRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # The properties.
+    # The cell format.
     attr_accessor :format
 
-    # Path to table row.
+    # The path to the table row in the document tree.
     attr_accessor :table_row_path
 
     # Object index.
@@ -64,9 +64,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param format The properties.
-    # @param table_row_path Path to table row.
+    # @param name The filename of the input document.
+    # @param format The cell format.
+    # @param table_row_path The path to the table row in the document tree.
     # @param index Object index.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -29,16 +29,16 @@ module AsposeWordsCloud
   # Request model for update_table_properties operation.
   #
   class UpdateTablePropertiesRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # The properties.
+    # The properties of the table.
     attr_accessor :properties
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node, which contains tables.
+    # 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 properties The properties.
+    # @param name The filename of the input document.
+    # @param properties The properties of the table.
     # @param index Object index.
-    # @param node_path Path to the node, which contains tables.
+    # @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_table_row_format_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for update_table_row_format operation.
   #
   class UpdateTableRowFormatRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Table row format.
+    # The row format.
     attr_accessor :format
 
-    # Path to table.
+    # The path to the table in the document tree.
     attr_accessor :table_path
 
     # Object index.
@@ -64,9 +64,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param format Table row format.
-    # @param table_path Path to table.
+    # @param name The filename of the input document.
+    # @param format The row format.
+    # @param table_path The path to the table in the document tree.
     # @param index Object index.
     # @param folder Original document folder.
     # @param storage Original document storage.

data/lib/aspose_words_cloud/models/response_error.rb

@@ -29,19 +29,19 @@ module AsposeWordsCloud
 
   # Api error.
   class ResponseError
-    # Gets or sets api error code.
+    # Gets or sets the API error code.
     attr_accessor :code
 
-    # Gets or sets server datetime.
+    # Gets or sets the server DateTime.
     attr_accessor :date_time
 
-    # Gets or sets error description.
+    # Gets or sets the error description.
     attr_accessor :description
 
-    # Gets or sets inner error.
+    # Gets or sets the inner error.
     attr_accessor :inner_error
 
-    # Gets or sets error message.
+    # Gets or sets the error message.
     attr_accessor :message
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/revisions_modification_response.rb

@@ -27,12 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # response of the modification operations for the revisions collection (now these are acceptAll and rejectAll).
+  # The REST response with a result of the modification operations for the revisions collection (now these are acceptAll and rejectAll).
   class RevisionsModificationResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets result of the modification operations for the revisions collection.
+    # Gets or sets the result of the modification operations for the revisions collection.
     attr_accessor :result
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/rtf_save_options_data.rb

@@ -27,50 +27,47 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # container class for rtf save options.
+  # Container class for rtf save options.
   class RtfSaveOptionsData
-    # Gets or sets a value determining how 3D effects are rendered.
+    # Gets or sets the value determining how 3D effects are rendered.
     attr_accessor :dml3_d_effects_rendering_mode
 
-    # Gets or sets a value determining how DrawingML effects are rendered.
+    # Gets or sets the value determining how DrawingML effects are rendered.
     # { Simplified | None | Fine }.
     attr_accessor :dml_effects_rendering_mode
 
-    # Gets or sets a value determining how DrawingML shapes are rendered.
-    # { Fallback | DrawingML }.
+    # Gets or sets the option that controls how DrawingML shapes are rendered.
     attr_accessor :dml_rendering_mode
 
-    # Gets or sets name of destination file.
+    # Gets or sets the name of destination file.
     attr_accessor :file_name
 
-    # Gets or sets format of save.
+    # Gets or sets the format of save.
     attr_accessor :save_format
 
-    # Gets or sets a value determining if fields should be updated before saving the document to a fixed page format.
-    # Default value for this property is. true.
+    # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
     attr_accessor :update_fields
 
-    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted
-    # property is updated before saving.
+    # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.
     attr_accessor :update_last_printed_property
 
-    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
+    # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
     attr_accessor :update_last_saved_time_property
 
-    # Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
+    # Gets or sets a value indicating whether content of StructuredDocumentTag is updated before saving.
     attr_accessor :update_sdt_content
 
-    # Gets or sets controls zip output or not.
-    # Default value is false.
+    # Gets or sets a value indicating whether to zip output or not.
+    # The default value is false.
     attr_accessor :zip_output
 
-    # Gets or sets allows to make output RTF documents smaller in size, but if they contain RTL (right-to-left) text, it will not be displayed correctly.
+    # Gets or sets a value indicating whether to make output RTF documents smaller in size, but if they contain RTL (right-to-left) text, it will not be displayed correctly.
     attr_accessor :export_compact_size
 
-    # Gets or sets specifies whether the keywords for "old readers" are written to RTF or not.
+    # Gets or sets a value indicating whether the keywords for "old readers" are written to RTF or not.
     attr_accessor :export_images_for_old_readers
 
-    # Gets or sets specifies whether or not use pretty formats output.
+    # Gets or sets a value indicating whether to use pretty formats output.
     attr_accessor :pretty_format
 
     # Gets or sets a value indicating whether when true all images will be saved as WMF. This option might help to avoid WordPad warning messages.

data/lib/aspose_words_cloud/models/run.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
 
   # Run element.
   class Run
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets node id.
+    # Gets or sets the node id.
     attr_accessor :node_id
 
-    # Gets or sets run's text.
+    # Gets or sets the run's text.
     attr_accessor :text
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/run_base.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
 
   # Run element.
   class RunBase
-    # Gets or sets run's text.
+    # Gets or sets the run's text.
     attr_accessor :text
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/run_insert.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
 
   # Run element for insert.
   class RunInsert
-    # Gets or sets run's text.
+    # Gets or sets the run's text.
     attr_accessor :text
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/run_link.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
 
   # Run link element.
   class RunLink
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets node id.
+    # Gets or sets the node id.
     attr_accessor :node_id
 
-    # Gets or sets run's text.
+    # Gets or sets the run's text.
     attr_accessor :text
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/run_response.rb

@@ -27,13 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:
-  # GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/runs/{1}.
+  # The REST response with a Run element.
   class RunResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets run.
+    # Gets or sets the Run element.
     attr_accessor :run
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/run_update.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
 
   # Run element for insert.
   class RunUpdate
-    # Gets or sets run's text.
+    # Gets or sets the run's text.
     attr_accessor :text
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/runs.rb

@@ -27,12 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # Represents DTO for collection of runs.
+  # DTO container with a collection of runs.
   class Runs
-    # Gets or sets link to the document.
+    # Gets or sets the link to the document.
     attr_accessor :link
 
-    # Gets or sets collection of fields.
+    # Gets or sets the collection of runs.
     attr_accessor :list
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/runs_response.rb

@@ -27,13 +27,12 @@ require 'date'
 
 module AsposeWordsCloud
 
-  # This response should be returned by the service when handling:
-  # GET https://api.aspose.cloud/v4.0/words/Test.doc/{paragraphPath}/runs.
+  # The REST response with a collection of Run elements.
   class RunsResponse
-    # Gets or sets request Id.
+    # Gets or sets the request Id.
     attr_accessor :request_id
 
-    # Gets or sets collection of runs.
+    # Gets or sets the collection of Run elements.
     attr_accessor :runs
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map

data/lib/aspose_words_cloud/models/save_options_data.rb

@@ -29,39 +29,36 @@ module AsposeWordsCloud
 
   # base container class for save options data.
   class SaveOptionsData
-    # Gets or sets a value determining how 3D effects are rendered.
+    # Gets or sets the value determining how 3D effects are rendered.
     attr_accessor :dml3_d_effects_rendering_mode
 
-    # Gets or sets a value determining how DrawingML effects are rendered.
+    # Gets or sets the value determining how DrawingML effects are rendered.
     # { Simplified | None | Fine }.
     attr_accessor :dml_effects_rendering_mode
 
-    # Gets or sets a value determining how DrawingML shapes are rendered.
-    # { Fallback | DrawingML }.
+    # Gets or sets the option that controls how DrawingML shapes are rendered.
     attr_accessor :dml_rendering_mode
 
-    # Gets or sets name of destination file.
+    # Gets or sets the name of destination file.
     attr_accessor :file_name
 
-    # Gets or sets format of save.
+    # Gets or sets the format of save.
     attr_accessor :save_format
 
-    # Gets or sets a value determining if fields should be updated before saving the document to a fixed page format.
-    # Default value for this property is. true.
+    # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
     attr_accessor :update_fields
 
-    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted
-    # property is updated before saving.
+    # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.
     attr_accessor :update_last_printed_property
 
-    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
+    # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
     attr_accessor :update_last_saved_time_property
 
-    # Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
+    # Gets or sets a value indicating whether content of StructuredDocumentTag is updated before saving.
     attr_accessor :update_sdt_content
 
-    # Gets or sets controls zip output or not.
-    # Default value is false.
+    # Gets or sets a value indicating whether to zip output or not.
+    # The default value is false.
     attr_accessor :zip_output
 
     class EnumAttributeValidator