From 1550015264b74f84ba837b5bb582ba4a0b5b95c8 Mon Sep 17 00:00:00 2001 From: Natalia Date: Tue, 2 Aug 2022 15:04:05 +0300 Subject: [PATCH 1/3] small fixes for word api documentation --- word/apiBuilder.js | 153 +++++++++++++++++++++++---------------------- 1 file changed, 77 insertions(+), 76 deletions(-) diff --git a/word/apiBuilder.js b/word/apiBuilder.js index 62a498a371..ea374df314 100644 --- a/word/apiBuilder.js +++ b/word/apiBuilder.js @@ -2975,7 +2975,7 @@ ApiPictureForm.prototype.constructor = ApiPictureForm; /** - * Class representing a complex form + * Class representing a complex form. * @param oSdt * @constructor * @extends {ApiFormBase} @@ -3666,7 +3666,7 @@ * | "textCurveDown" | "textCurveUp" | "textDeflate" | "textDeflateBottom" | "textDeflateInflate" | "textDeflateInflateDeflate" | "textDeflateTop" * | "textDoubleWave1" | "textFadeDown" | "textFadeLeft" | "textFadeRight" | "textFadeUp" | "textInflate" | "textInflateBottom" | "textInflateTop" * | "textPlain" | "textRingInside" | "textRingOutside" | "textSlantDown" | "textSlantUp" | "textStop" | "textTriangle" | "textTriangleInverted" - * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransofrm + * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransform * */ /** @@ -3703,62 +3703,62 @@ //------------------------------------------------------------------------------------------------------------------ /** - * Available values of the "numbered" reference type. - * * **"pageNum"** - the page number of the numbered item. - * * **"paraNum"** - the paragraph number of the numbered item. - * * **"noCtxParaNum"** - an abbreviated paragraph number (the specific item of the numbered list only, e.g., instead of "4.1.1" you refer to "1" only). - * * **"fullCtxParaNum"** - a full paragraph number, e.g., "4.1.1". - * * **"text"** - the text value of the paragraph, e.g., if you have "4.1.1. Terms and Conditions", you refer to "Terms and Conditions" only. + * Available values of the "numbered" reference type: + * * **"pageNum"** - the page number of the numbered item; + * * **"paraNum"** - the paragraph number of the numbered item; + * * **"noCtxParaNum"** - an abbreviated paragraph number (the specific item of the numbered list only, e.g., instead of "4.1.1" you refer to "1" only); + * * **"fullCtxParaNum"** - a full paragraph number, e.g., "4.1.1"; + * * **"text"** - the text value of the paragraph, e.g., if you have "4.1.1. Terms and Conditions", you refer to "Terms and Conditions" only; * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. * @typedef {"pageNum" | "paraNum" | "noCtxParaNum" | "fullCtxParaNum" | "text" | "aboveBelow"} numberedRefTo */ /** - * Available values of the "heading" reference type. - * * **"text"** - the entire text of the heading. - * * **"pageNum"** - the page number of the heading. - * * **"headingNum"** - the sequence number of the heading. - * * **"noCtxHeadingNum"** - an abbreviated heading number. Make sure the cursor point is in the section you are referencing to, e.g., you are in section 4 and you wish to refer to heading 4.B, so instead of "4.B" you receive "B" only. - * * **"fullCtxHeadingNum"** - a full heading number even if the cursor point is in the same section. + * Available values of the "heading" reference type: + * * **"text"** - the entire text of the heading; + * * **"pageNum"** - the page number of the heading; + * * **"headingNum"** - the sequence number of the heading; + * * **"noCtxHeadingNum"** - an abbreviated heading number. Make sure the cursor point is in the section you are referencing to, e.g., you are in section 4 and you wish to refer to heading 4.B, so instead of "4.B" you receive "B" only; + * * **"fullCtxHeadingNum"** - a full heading number even if the cursor point is in the same section; * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. * @typedef {"text" | "pageNum" | "headingNum" | "noCtxHeadingNum" | "fullCtxHeadingNum" | "aboveBelow"} headingRefTo */ /** - * Available values of the "bookmark" reference type. - * * **"text"** - the entire text of the bookmark. - * * **"pageNum"** - the page number of the bookmark. - * * **"paraNum"** - the paragraph number of the bookmark. - * * **"noCtxParaNum"** - an abbreviated paragraph number (the specific item only, e.g., instead of "4.1.1" you refer to "1" only). - * * **"fullCtxParaNum"** - a full paragraph number, e.g., "4.1.1". + * Available values of the "bookmark" reference type: + * * **"text"** - the entire text of the bookmark; + * * **"pageNum"** - the page number of the bookmark; + * * **"paraNum"** - the paragraph number of the bookmark; + * * **"noCtxParaNum"** - an abbreviated paragraph number (the specific item only, e.g., instead of "4.1.1" you refer to "1" only); + * * **"fullCtxParaNum"** - a full paragraph number, e.g., "4.1.1"; * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. * @typedef {"text" | "pageNum" | "paraNum" | "noCtxParaNum" | "fullCtxParaNum" | "aboveBelow"} bookmarkRefTo */ /** - * Available values of the "footnote" reference type. - * * **"footnoteNum"** - the footnote number. - * * **"pageNum"** - the page number of the footnote. - * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. + * Available values of the "footnote" reference type: + * * **"footnoteNum"** - the footnote number; + * * **"pageNum"** - the page number of the footnote; + * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item; * * **"formFootnoteNum"** - the number of the footnote formatted as a footnote. The numbering of the actual footnotes is not affected. * @typedef {"footnoteNum" | "pageNum" | "aboveBelow" | "formFootnoteNum"} footnoteRefTo */ /** - * Available values of the "endnote" reference type. - * * **"endnoteNum"** - the endnote number. - * * **"pageNum"** - the page number of the endnote. - * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. + * Available values of the "endnote" reference type: + * * **"endnoteNum"** - the endnote number; + * * **"pageNum"** - the page number of the endnote; + * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item; * * **"formEndnoteNum"** - the number of the endnote formatted as an endnote. The numbering of the actual endnotes is not affected. * @typedef {"endnoteNum" | "pageNum" | "aboveBelow" | "formEndnoteNum"} endnoteRefTo */ /** - * Available values of the "equation"/"figure"/"table" reference type. - * * **"entireCaption"** - the full text of the caption. - * * **"labelNumber"** - the label and object number only, e.g., "Table 1.1". - * * **"captionText"** - the text of the caption only. - * * **"pageNum"** - the page number containing the referenced object. + * Available values of the "equation"/"figure"/"table" reference type: + * * **"entireCaption"** - the full text of the caption; + * * **"labelNumber"** - the label and object number only, e.g., "Table 1.1"; + * * **"captionText"** - the text of the caption only; + * * **"pageNum"** - the page number containing the referenced object; * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. * @typedef {"entireCaption" | "labelNumber" | "captionText" | "pageNum" | "aboveBelow"} captionRefTo */ @@ -3783,7 +3783,7 @@ */ /** - * Types of all supported forms + * Types of all supported forms. * @typedef {ApiTextForm | ApiComboBoxForm | ApiCheckBoxForm | ApiPictureForm | ApiComplexForm} ApiForm */ @@ -3993,14 +3993,14 @@ }; /** - * Creates an Ole-object with the parameters specified. + * Creates an OLE object with the parameters specified. * @memberof Api * @typeofeditors ["CDE"] - * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently only internet URL or Base64 encoded images are supported). - * @param {EMU} nWidth - The Ole-object width in English measure units. - * @param {EMU} nHeight - The Ole-object height in English measure units. - * @param {string} sData - ole-object string data. - * @param {string} sAppId - the application id associated with this object. + * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently, only internet URL or Base64 encoded images are supported). + * @param {EMU} nWidth - The OLE object width in English measure units. + * @param {EMU} nHeight - The OLE object height in English measure units. + * @param {string} sData - The OLE object string data. + * @param {string} sAppId - The application ID associated with the current OLE object. * @returns {ApiOleObject} */ Api.prototype.CreateOleObject = function(sImageSrc, nWidth, nHeight, sData, sAppId) @@ -4894,7 +4894,7 @@ return aContent; }; /** - * Returns a collection of drawing objects in the document content. + * Returns a collection of drawing objects from the document content. * @memberof ApiDocumentContent * @typeofeditors ["CDE"] * @return {ApiDrawing[]} @@ -4910,7 +4910,7 @@ return arrApiShapes; }; /** - * Returns a collection of shape objects in the document content. + * Returns a collection of shape objects from the document content. * @memberof ApiDocumentContent * @typeofeditors ["CDE"] * @return {ApiShape[]} @@ -4929,7 +4929,7 @@ return arrApiShapes; }; /** - * Returns a collection of image objects in the document content. + * Returns a collection of image objects from the document content. * @memberof ApiDocumentContent * @typeofeditors ["CDE"] * @return {ApiImage[]} @@ -4948,7 +4948,7 @@ return arrApiImages; }; /** - * Returns a collection of chart objects in the document content. + * Returns a collection of chart objects from the document content. * @memberof ApiDocumentContent * @typeofeditors ["CDE"] * @return {ApiChart[]} @@ -4967,7 +4967,7 @@ return arrApiCharts; }; /** - * Returns a collection of ole-objects in the document content. + * Returns a collection of OLE objects from the document content. * @memberof ApiDocumentContent * @typeofeditors ["CDE"] * @return {ApiOleObject[]} @@ -5391,7 +5391,7 @@ this.Document.ReplaceSearchElement(sReplace, true, null, false); }; /** - * Returns a list of all the content controls in the document. + * Returns a list of all the content controls from the document. * @memberof ApiDocument * @typeofeditors ["CDE"] * @returns {ApiBlockLvlSdt[] | ApiInlineLvlSdt[]} @@ -5410,7 +5410,7 @@ return arrResult; }; /** - * Returns a list of all tags that are used for all content controls in the document + * Returns a list of all tags that are used for all content controls in the document. * @memberof ApiDocument * @typeofeditors ["CDE"] * @returns {String[]} @@ -5435,7 +5435,7 @@ return arrResult; }; /** - * Returns a list of all tags that are used for all special forms in the document + * Returns a list of all tags that are used for all forms in the document. * @memberof ApiDocument * @typeofeditors ["CDE"] * @returns {String[]} @@ -5460,10 +5460,10 @@ return arrResult; }; /** - * Returns a list of all the content controls in the document with specified tag name + * Returns a list of all content controls in the document with the specified tag name. * @memberof ApiDocument * @typeofeditors ["CDE"] - * @param sTag {string} + * @param sTag {string} - Content control tag. * @returns {ApiBlockLvlSdt[] | ApiInlineLvlSdt[]} */ ApiDocument.prototype.GetContentControlsByTag = function(sTag) @@ -5485,10 +5485,10 @@ return arrResult; }; /** - * Returns a list of all the special forms in the document with specified tag name + * Returns a list of all forms in the document with the specified tag name. * @memberof ApiDocument * @typeofeditors ["CDE"] - * @param sTag {string} + * @param sTag {string} - Form tag. * @returns {ApiBlockLvlSdt[] | ApiInlineLvlSdt[]} */ ApiDocument.prototype.GetFormsByTag = function(sTag) @@ -6165,7 +6165,7 @@ }; /** - * Returns the selected drawings. + * Returns all the selected drawings in the current document. * @memberof ApiDocument * @typeofeditors ["CDE"] * @returns {ApiShape[] | ApiImage[] | ApiChart[] | ApiDrawing[]} @@ -6247,7 +6247,7 @@ }; /** - * Adds footnote for selected text (or current position if selection doesn't exist). + * Adds a footnote for the selected text (or the current position if the selection doesn't exist). * @memberof ApiDocument * @typeofeditors ["CDE"] * @returns {?ApiDocumentContent} @@ -6262,7 +6262,7 @@ }; /** - * Adds endnote for selected text (or current position if selection doesn't exist). + * Adds an endnote for the selected text (or the current position if the selection doesn't exist). * @memberof ApiDocument * @typeofeditors ["CDE"] * @returns {?ApiDocumentContent} @@ -7276,7 +7276,7 @@ return arrApiCharts; }; /** - * Returns a collection of ole-objects in the paragraph. + * Returns a collection of OLE objects in the paragraph. * @memberof ApiParagraph * @typeofeditors ["CDE"] * @return {ApiOleObject[]} @@ -7974,7 +7974,7 @@ }; /** - * Returns the paragraph position in its parent element. + * Returns the paragraph position within its parent element. * @memberof ApiParagraph * @typeofeditors ["CDE"] * @returns {Number} - returns -1 if the paragraph parent doesn't exist. @@ -9849,7 +9849,7 @@ }; /** - * Returns the table position in its parent element. + * Returns the table position within its parent element. * @memberof ApiTable * @typeofeditors ["CDE"] * @returns {Number} - returns -1 if the table parent doesn't exist. @@ -12208,7 +12208,7 @@ * Sets the table title (caption). * @memberof ApiTablePr * @typeofeditors ["CDE"] - * @param {string} sTitle - the table title to be set. + * @param {string} sTitle - The table title to be set. * @return {boolean} */ ApiTablePr.prototype.SetTableTitle = function(sTitle) @@ -12221,7 +12221,7 @@ return true; }; /** - * Gets the table title (caption). + * Returns the table title (caption). * @memberof ApiTablePr * @typeofeditors ["CDE"] * @return {string} @@ -12237,7 +12237,7 @@ * Sets the table description. * @memberof ApiTablePr * @typeofeditors ["CDE"] - * @param {string} sDescr - the table description to be set. + * @param {string} sDescr - The table description to be set. * @return {boolean} */ ApiTablePr.prototype.SetTableDescription = function(sDescr) @@ -12250,7 +12250,7 @@ return true; }; /** - * Gets the table description. + * Returns the table description. * @memberof ApiTablePr * @typeofeditors ["CDE"] * @return {string} @@ -13302,9 +13302,9 @@ /** * Sets the properties from another drawing to the current drawing. - * The following properties will be copied: PosH, PosV, Distance, WrappingStyle, drawing name, title and description. + * The following properties will be copied: horizontal and vertical alignment, distance between the edges of the current drawing object and any subsequent text, wrapping style, drawing name, title and description. * @memberof ApiDrawing - * @param {ApiDrawing} oAnotherDrawing - Drawing whose properties will be set to the current drawing. + * @param {ApiDrawing} oAnotherDrawing - The drawing which properties will be set to the current drawing. * @typeofeditors ["CDE"] * @returns {boolean} */ @@ -13404,10 +13404,10 @@ }; /** - * Sets the data to current Ole-object. + * Sets the data to the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {string} sData - ole-object string data. + * @param {string} sData - The OLE object string data. * @returns {boolean} */ ApiOleObject.prototype.SetData = function(sData) @@ -13420,7 +13420,7 @@ }; /** - * Gets the string data from current Ole-object. + * Returns the string data from the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} @@ -13434,10 +13434,10 @@ }; /** - * Sets the application id to current Ole-object. + * Sets the application ID to the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {string} sAppId - the application id associated with this object. + * @param {string} sAppId - The application ID associated with the curent OLE object. * @returns {boolean} */ ApiOleObject.prototype.SetApplicationId = function(sAppId) @@ -13450,7 +13450,7 @@ }; /** - * Gets the application id from current Ole-object. + * Returns the application ID from the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} @@ -15555,7 +15555,7 @@ }; /** - * Returns the content control position in its parent element. + * Returns the content control position within its parent element. * @memberof ApiBlockLvlSdt * @typeofeditors ["CDE"] * @returns {Number} - returns -1 if the content control parent doesn't exist. @@ -16569,11 +16569,12 @@ }; /** + * Replaces each paragraph (or text in cell) in the select with the corresponding text from an array of strings. * @memberof Api * @typeofeditors ["CDE", "CSE", "CPE"] * @param {Array} arrString - An array of replacement strings. - * @param {string} [sParaTab=" "] - specifies which character to use to define the tab in the source text. - * @param {string} [sParaNewLine=" "] - specifies which character to use to specify the line break character in the source text. + * @param {string} [sParaTab=" "] - A character which is used to specify the tab in the source text. + * @param {string} [sParaNewLine=" "] - A character which is used to specify the line break character in the source text. */ Api.prototype.ReplaceTextSmart = function(arrString, sParaTab, sParaNewLine) { @@ -17013,12 +17014,12 @@ * @typeofeditors ["CDE"] * @param {ApiTextPr} [oTextPr=Api.CreateTextPr()] - The text properties. * @param {string} [sText="Your text here"] - The text for the Text Art object. - * @param {TextTransofrm} [sTransform="textNoShape"] - Text transform type. + * @param {TextTransform} [sTransform="textNoShape"] - Text transform type. * @param {ApiFill} [oFill=Api.CreateNoFill()] - The color or pattern used to fill the Text Art object. * @param {ApiStroke} [oStroke=Api.CreateStroke(0, Api.CreateNoFill())] - The stroke used to create the Text Art object shadow. * @param {number} [nRotAngle=0] - Rotation angle. - * @param {EMU} [nWidth=1828800] - Text Art width measured in English measure units. - * @param {EMU} [nHeight=1828800] - Text Art heigth measured in English measure units. + * @param {EMU} [nWidth=1828800] - The Text Art width measured in English measure units. + * @param {EMU} [nHeight=1828800] - The Text Art heigth measured in English measure units. * @returns {ApiDrawing} */ Api.prototype.CreateWordArt = function(oTextPr, sText, sTransform, oFill, oStroke, nRotAngle, nWidth, nHeight) { From 6668ea0d46ea933b6e78d6ff197126dbbefac045 Mon Sep 17 00:00:00 2001 From: Natalia Date: Tue, 2 Aug 2022 16:31:23 +0300 Subject: [PATCH 2/3] small fixes for the cell api documentation --- cell/apiBuilder.js | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/cell/apiBuilder.js b/cell/apiBuilder.js index bfcfc72a7d..7d1f664c41 100644 --- a/cell/apiBuilder.js +++ b/cell/apiBuilder.js @@ -161,7 +161,7 @@ ApiChart.prototype.constructor = ApiChart; /** - * Class representing an Ole-object. + * Class representing an OLE object. * @constructor */ function ApiOleObject(OleObject) @@ -228,7 +228,7 @@ * | "textCurveDown" | "textCurveUp" | "textDeflate" | "textDeflateBottom" | "textDeflateInflate" | "textDeflateInflateDeflate" | "textDeflateTop" * | "textDoubleWave1" | "textFadeDown" | "textFadeLeft" | "textFadeRight" | "textFadeUp" | "textInflate" | "textInflateBottom" | "textInflateTop" * | "textPlain" | "textRingInside" | "textRingOutside" | "textSlantDown" | "textSlantUp" | "textStop" | "textTriangle" | "textTriangleInverted" - * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransofrm + * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransform * */ /** @@ -1465,12 +1465,12 @@ * @typeofeditors ["CSE"] * @param {ApiTextPr} [oTextPr=Api.CreateTextPr()] - The text properties. * @param {string} [sText="Your text here"] - The text for the Text Art object. - * @param {TextTransofrm} [sTransform="textNoShape"] - Text transform type. + * @param {TextTransform} [sTransform="textNoShape"] - Text transform type. * @param {ApiFill} [oFill=Api.CreateNoFill()] - The color or pattern used to fill the Text Art object. * @param {ApiStroke} [oStroke=Api.CreateStroke(0, Api.CreateNoFill())] - The stroke used to create the Text Art object shadow. * @param {number} [nRotAngle=0] - Rotation angle. - * @param {EMU} [nWidth=1828800] - Text Art width measured in English measure units. - * @param {EMU} [nHeight=1828800] - Text Art heigth measured in English measure units. + * @param {EMU} [nWidth=1828800] - The Text Art width measured in English measure units. + * @param {EMU} [nHeight=1828800] - The Text Art heigth measured in English measure units. * @param {number} [nFromCol=0] - The column number where the beginning of the Text Art object will be placed. * @param {number} [nFromRow=0] - The row number where the beginning of the Text Art object will be placed. * @param {EMU} [nColOffset=0] - The offset from the nFromCol column to the left part of the Text Art object measured in English measure units. @@ -1498,18 +1498,18 @@ }; /** - * Adds an Ole-object with the parameters specified. + * Adds an OLE object to the current sheet with the parameters specified. * @memberof ApiWorksheet * @typeofeditors ["CSE"] - * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently only internet URL or Base64 encoded images are supported). - * @param {EMU} nWidth - The Ole-object width in English measure units. - * @param {EMU} nHeight - The Ole-object height in English measure units. - * @param {string} sData - ole-object string data. - * @param {string} sAppId - the application id associated with this object. - * @param {number} nFromCol - The number of the column where the beginning of the Ole-object will be placed. - * @param {EMU} nColOffset - The offset from the nFromCol column to the left part of the Ole-object measured in English measure units. - * @param {number} nFromRow - The number of the row where the beginning of the Ole-object will be placed. - * @param {EMU} nRowOffset - The offset from the nFromRow row to the upper part of the Ole-object measured in English measure units. + * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently, only internet URL or Base64 encoded images are supported). + * @param {EMU} nWidth - The OLE object width in English measure units. + * @param {EMU} nHeight - The OLE object height in English measure units. + * @param {string} sData - The OLE object string data. + * @param {string} sAppId - The application ID associated with the current OLE object. + * @param {number} nFromCol - The number of the column where the beginning of the OLE object will be placed. + * @param {EMU} nColOffset - The offset from the nFromCol column to the left part of the OLE object measured in English measure units. + * @param {number} nFromRow - The number of the row where the beginning of the OLE object will be placed. + * @param {EMU} nRowOffset - The offset from the nFromRow row to the upper part of the OLE object measured in English measure units. * @returns {ApiOleObject} */ ApiWorksheet.prototype.AddOleObject = function(sImageSrc, nWidth, nHeight, sData, sAppId, nFromCol, nColOffset, nFromRow, nRowOffset) @@ -1692,7 +1692,7 @@ }; /** - * Returns all ole-objects from the current sheet. + * Returns all OLE objects from the current sheet. * @memberof ApiWorksheet * @typeofeditors ["CSE"] * @returns {ApiOleObject[]}. @@ -3931,10 +3931,10 @@ }; /** - * Sets the data to current Ole-object. + * Sets the data to the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {string} sData - ole-object string data. + * @param {string} sData - The OLE object string data. * @returns {boolean} */ ApiOleObject.prototype.SetData = function(sData) @@ -3947,7 +3947,7 @@ }; /** - * Gets the string data from current Ole-object. + * Returns the string data from the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} @@ -3961,10 +3961,10 @@ }; /** - * Sets the application id to current Ole-object. + * Sets the application ID to the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {string} sAppId - the application id associated with this object. + * @param {string} sAppId - The application ID associated with the current OLE object. * @returns {boolean} */ ApiOleObject.prototype.SetApplicationId = function(sAppId) @@ -3977,7 +3977,7 @@ }; /** - * Gets the application id from current Ole-object. + * Returns the application ID from the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} From d35008a962e49615032435eeb9346d55e59820dd Mon Sep 17 00:00:00 2001 From: Natalia Date: Tue, 2 Aug 2022 17:07:04 +0300 Subject: [PATCH 3/3] small fixes for the slide and word api documentation --- slide/apiBuilder.js | 44 ++++++++++++++++---------------- word/apiBuilder.js | 62 ++++++++++++++++++++++----------------------- 2 files changed, 53 insertions(+), 53 deletions(-) diff --git a/slide/apiBuilder.js b/slide/apiBuilder.js index 5b2b3a0bba..107a6af96c 100644 --- a/slide/apiBuilder.js +++ b/slide/apiBuilder.js @@ -164,7 +164,7 @@ ApiGroup.prototype.constructor = ApiGroup; /** - * Class representing an Ole-object. + * Class representing an OLE object. * @constructor */ function ApiOleObject(OleObject) @@ -323,18 +323,18 @@ * */ /** - * Text transform preset + * Text transform type. * @typedef {("textArchDown" | "textArchDownPour" | "textArchUp" | "textArchUpPour" | "textButton" | "textButtonPour" | "textCanDown" * | "textCanUp" | "textCascadeDown" | "textCascadeUp" | "textChevron" | "textChevronInverted" | "textCircle" | "textCirclePour" * | "textCurveDown" | "textCurveUp" | "textDeflate" | "textDeflateBottom" | "textDeflateInflate" | "textDeflateInflateDeflate" | "textDeflateTop" * | "textDoubleWave1" | "textFadeDown" | "textFadeLeft" | "textFadeRight" | "textFadeUp" | "textInflate" | "textInflateBottom" | "textInflateTop" * | "textPlain" | "textRingInside" | "textRingOutside" | "textSlantDown" | "textSlantUp" | "textStop" | "textTriangle" | "textTriangleInverted" - * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransofrm + * | "textWave1" | "textWave2" | "textWave4" | "textNoShape")} TextTransform * */ /** * Axis position in the chart. - * @typedef {("top" | "bottom" | "right" | "left")} AxiePos + * @typedef {("top" | "bottom" | "right" | "left")} AxisPos */ /** @@ -611,14 +611,14 @@ }; /** - * Creates an Ole-object with the parameters specified. + * Creates an OLE object with the parameters specified. * @memberof Api * @typeofeditors ["CPE"] - * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently only internet URL or Base64 encoded images are supported). - * @param {EMU} nWidth - The Ole-object width in English measure units. - * @param {EMU} nHeight - The Ole-object height in English measure units. - * @param {string} sData - ole-object string data. - * @param {string} sAppId - the application id associated with this object. + * @param {string} sImageSrc - The image source where the image to be inserted should be taken from (currently, only internet URL or Base64 encoded images are supported). + * @param {EMU} nWidth - The OLE object width in English measure units. + * @param {EMU} nHeight - The OLE object height in English measure units. + * @param {string} sData - The OLE object string data. + * @param {string} sAppId - The application ID associated with the current OLE object. * @returns {ApiOleObject} */ Api.prototype.CreateOleObject = function(sImageSrc, nWidth, nHeight, sData, sAppId) @@ -850,12 +850,12 @@ * @typeofeditors ["CPE"] * @param {ApiTextPr} [oTextPr=Api.CreateTextPr()] - The text properties. * @param {string} [sText="Your text here"] - The text for the Text Art object. - * @param {TextTransofrm} [sTransform="textNoShape"] - Text transform type. + * @param {TextTransform} [sTransform="textNoShape"] - Text transform type. * @param {ApiFill} [oFill=Api.CreateNoFill()] - The color or pattern used to fill the Text Art object. * @param {ApiStroke} [oStroke=Api.CreateStroke(0, Api.CreateNoFill())] - The stroke used to create the Text Art object shadow. * @param {number} [nRotAngle=0] - Rotation angle. - * @param {EMU} [nWidth=1828800] - Text Art width measured in English measure units. - * @param {EMU} [nHeight=1828800] - Text Art heigth measured in English measure units. + * @param {EMU} [nWidth=1828800] - The Text Art width measured in English measure units. + * @param {EMU} [nHeight=1828800] - The Text Art heigth measured in English measure units. * @param {EMU} [nIndLeft=ApiPresentation.GetWidth() / 2] - The Text Art left side indentation value measured in English measure units. * @param {EMU} [nIndTop=ApiPresentation.GetHeight() / 2] - The Text Art top side indentation value measured in English measure units. * @returns {ApiDrawing} @@ -1688,7 +1688,7 @@ }; /** - * Returns an array with all the ole-objects from the slide master. + * Returns an array with all the OLE objects from the slide master. * @typeofeditors ["CPE"] * @returns {ApiOleObject[]} * */ @@ -2009,7 +2009,7 @@ }; /** - * Returns an array with all the ole-objects from the slide layout. + * Returns an array with all the OLE objects from the slide layout. * @typeofeditors ["CPE"] * @returns {ApiOleObject[]} * */ @@ -3072,7 +3072,7 @@ }; /** - * Returns an array with all the ole-objects from the slide. + * Returns an array with all the OLE objects from the slide. * @typeofeditors ["CPE"] * @returns {ApiOleObject[]} * */ @@ -4112,10 +4112,10 @@ }; /** - * Sets the data to current Ole-object. + * Sets the data to the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {string} sData - ole-object string data. + * @param {string} sData - The OLE object string data. * @returns {boolean} */ ApiOleObject.prototype.SetData = function(sData) @@ -4128,7 +4128,7 @@ }; /** - * Gets the string data from current Ole-object. + * Returns the string data from the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} @@ -4142,10 +4142,10 @@ }; /** - * Sets the application id to current Ole-object. + * Sets the application ID to the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] - * @param {string} sAppId - the application id associated with this object. + * @param {string} sAppId - The application ID associated with the current OLE object. * @returns {boolean} */ ApiOleObject.prototype.SetApplicationId = function(sAppId) @@ -4158,7 +4158,7 @@ }; /** - * Gets the application id from current Ole-object. + * Returns the application ID from the current OLE object. * @memberof ApiOleObject * @typeofeditors ["CDE", "CPE", "CSE"] * @returns {string} diff --git a/word/apiBuilder.js b/word/apiBuilder.js index ea374df314..e7ce91ec17 100644 --- a/word/apiBuilder.js +++ b/word/apiBuilder.js @@ -3703,62 +3703,62 @@ //------------------------------------------------------------------------------------------------------------------ /** - * Available values of the "numbered" reference type: - * * **"pageNum"** - the page number of the numbered item; - * * **"paraNum"** - the paragraph number of the numbered item; - * * **"noCtxParaNum"** - an abbreviated paragraph number (the specific item of the numbered list only, e.g., instead of "4.1.1" you refer to "1" only); - * * **"fullCtxParaNum"** - a full paragraph number, e.g., "4.1.1"; - * * **"text"** - the text value of the paragraph, e.g., if you have "4.1.1. Terms and Conditions", you refer to "Terms and Conditions" only; + * Available values of the "numbered" reference type. + * * **"pageNum"** - the page number of the numbered item. + * * **"paraNum"** - the paragraph number of the numbered item. + * * **"noCtxParaNum"** - an abbreviated paragraph number (the specific item of the numbered list only, e.g., instead of "4.1.1" you refer to "1" only). + * * **"fullCtxParaNum"** - a full paragraph number, e.g., "4.1.1". + * * **"text"** - the text value of the paragraph, e.g., if you have "4.1.1. Terms and Conditions", you refer to "Terms and Conditions" only. * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. * @typedef {"pageNum" | "paraNum" | "noCtxParaNum" | "fullCtxParaNum" | "text" | "aboveBelow"} numberedRefTo */ /** - * Available values of the "heading" reference type: - * * **"text"** - the entire text of the heading; - * * **"pageNum"** - the page number of the heading; - * * **"headingNum"** - the sequence number of the heading; - * * **"noCtxHeadingNum"** - an abbreviated heading number. Make sure the cursor point is in the section you are referencing to, e.g., you are in section 4 and you wish to refer to heading 4.B, so instead of "4.B" you receive "B" only; - * * **"fullCtxHeadingNum"** - a full heading number even if the cursor point is in the same section; + * Available values of the "heading" reference type. + * * **"text"** - the entire text of the heading. + * * **"pageNum"** - the page number of the heading. + * * **"headingNum"** - the sequence number of the heading. + * * **"noCtxHeadingNum"** - an abbreviated heading number. Make sure the cursor point is in the section you are referencing to, e.g., you are in section 4 and you wish to refer to heading 4.B, so instead of "4.B" you receive "B" only. + * * **"fullCtxHeadingNum"** - a full heading number even if the cursor point is in the same section. * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. * @typedef {"text" | "pageNum" | "headingNum" | "noCtxHeadingNum" | "fullCtxHeadingNum" | "aboveBelow"} headingRefTo */ /** - * Available values of the "bookmark" reference type: - * * **"text"** - the entire text of the bookmark; - * * **"pageNum"** - the page number of the bookmark; - * * **"paraNum"** - the paragraph number of the bookmark; - * * **"noCtxParaNum"** - an abbreviated paragraph number (the specific item only, e.g., instead of "4.1.1" you refer to "1" only); - * * **"fullCtxParaNum"** - a full paragraph number, e.g., "4.1.1"; + * Available values of the "bookmark" reference type. + * * **"text"** - the entire text of the bookmark. + * * **"pageNum"** - the page number of the bookmark. + * * **"paraNum"** - the paragraph number of the bookmark. + * * **"noCtxParaNum"** - an abbreviated paragraph number (the specific item only, e.g., instead of "4.1.1" you refer to "1" only). + * * **"fullCtxParaNum"** - a full paragraph number, e.g., "4.1.1". * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. * @typedef {"text" | "pageNum" | "paraNum" | "noCtxParaNum" | "fullCtxParaNum" | "aboveBelow"} bookmarkRefTo */ /** - * Available values of the "footnote" reference type: - * * **"footnoteNum"** - the footnote number; - * * **"pageNum"** - the page number of the footnote; - * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item; + * Available values of the "footnote" reference type. + * * **"footnoteNum"** - the footnote number. + * * **"pageNum"** - the page number of the footnote. + * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. * * **"formFootnoteNum"** - the number of the footnote formatted as a footnote. The numbering of the actual footnotes is not affected. * @typedef {"footnoteNum" | "pageNum" | "aboveBelow" | "formFootnoteNum"} footnoteRefTo */ /** - * Available values of the "endnote" reference type: - * * **"endnoteNum"** - the endnote number; - * * **"pageNum"** - the page number of the endnote; - * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item; + * Available values of the "endnote" reference type. + * * **"endnoteNum"** - the endnote number. + * * **"pageNum"** - the page number of the endnote. + * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. * * **"formEndnoteNum"** - the number of the endnote formatted as an endnote. The numbering of the actual endnotes is not affected. * @typedef {"endnoteNum" | "pageNum" | "aboveBelow" | "formEndnoteNum"} endnoteRefTo */ /** - * Available values of the "equation"/"figure"/"table" reference type: - * * **"entireCaption"** - the full text of the caption; - * * **"labelNumber"** - the label and object number only, e.g., "Table 1.1"; - * * **"captionText"** - the text of the caption only; - * * **"pageNum"** - the page number containing the referenced object; + * Available values of the "equation"/"figure"/"table" reference type. + * * **"entireCaption"** - the full text of the caption. + * * **"labelNumber"** - the label and object number only, e.g., "Table 1.1". + * * **"captionText"** - the text of the caption only. + * * **"pageNum"** - the page number containing the referenced object. * * **"aboveBelow"** - the words "above" or "below" depending on the position of the item. * @typedef {"entireCaption" | "labelNumber" | "captionText" | "pageNum" | "aboveBelow"} captionRefTo */