[plugins][api] Added paths to linkgs

ONLYOFFICE · Aug 2, 2024 · aa36418 · aa36418
1 parent 94c507d
commit aa36418
Show file tree

Hide file tree

Showing 5 changed files with 257 additions and 179 deletions.
diff --git a/cell/api_plugins.js b/cell/api_plugins.js
@@ -51,6 +51,7 @@
 	 * @property {string} Time - The time when the comment was posted (in milliseconds).
 	 * @property {boolean} Solved - Specifies if the comment is resolved (**true**) or not (**false**).
 	 * @property {CommentData[]} Replies - An array containing the comment replies represented as the *CommentData* object.
+	 * @see office-js-api\Examples\Plugins\Cell\Enumeration\CommentData.js
 	 */
 
 	/**
@@ -61,6 +62,7 @@
 	 * @param {CommentData}  oCommentData - An object which contains the comment data.
 	 * @return {string | null} - The comment ID in the string format or null if the comment cannot be added.
 	 * @since 7.3.0
+	 * @see office-js-api\Examples\Plugins\Cell\Api\Methods\AddComment.js
 	 */
 	Api.prototype["pluginMethod_AddComment"] = function (oCommentData) {
 		if (!oCommentData)
@@ -86,6 +88,7 @@
 	 * @param {CommentData} oCommentData - An object which contains the new comment data.
 	 * @return {boolean}
 	 * @since 7.3.0
+	 * @see office-js-api\Examples\Plugins\Cell\Api\Methods\ChangeComment.js
 	 */
 	Api.prototype["pluginMethod_ChangeComment"] = function (sId, oCommentData) {
 		if (!oCommentData)
@@ -108,6 +111,7 @@
 	 * @typeofeditors ["CSE"]
 	 * @alias RemoveComments
 	 * @since 7.3.0
+	 * @see office-js-api\Examples\Plugins\Cell\Api\Methods\RemoveComments.js
 	 */
 	Api.prototype["pluginMethod_RemoveComments"] = function (arrIds) {
 		for (let comm in arrIds) {
@@ -125,6 +129,7 @@
 	 * @alias GetAllComments
 	 * @returns {comment[]} - An array of comment objects containing the comment data.
 	 * @since 8.1.0
+	 * @see office-js-api\Examples\Plugins\Cell\Api\Methods\GetAllComments.js
 	 */
 	Api.prototype["pluginMethod_GetAllComments"] = function()
 	{
@@ -187,6 +192,7 @@
 	 * @alias GetCustomFunctions
 	 * @return {string} A library of custom functions in JSON format.
 	 * @since 8.1.0
+	 * @see office-js-api\Examples\Plugins\Cell\Api\Methods\GetCustomFunctions.js
 	 */
 	Api.prototype["pluginMethod_GetCustomFunctions"] = function()
 	{
@@ -209,6 +215,7 @@
 	 * @alias SetCustomFunctions
 	 * @param {string} jsonString - A library of custom functions in JSON format.
 	 * @since 8.1.0
+	 * @see office-js-api\Examples\Plugins\Cell\Api\Methods\SetCustomFunctions.js
 	 */
 	Api.prototype["pluginMethod_SetCustomFunctions"] = function(jsonString)
 	{
@@ -226,3 +233,4 @@
 	};
 
 })(window);
+