Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

chore: better comments (#4380)

lumix1680b327cce1
diff --git a/packages/core/src/facade/f-usermanager.ts b/packages/core/src/facade/f-usermanager.ts
index 21afb292fe..40e29f3341 100644
--- a/packages/core/src/facade/f-usermanager.ts
+++ b/packages/core/src/facade/f-usermanager.ts
@@ -30,7 +30,9 @@ export class FUserManager extends FBase {
/**
* Get current user info
* @example
- * `univerAPI.getUserManager().getCurrentUser()`
+ * ```
+ * univerAPI.getUserManager().getCurrentUser()
+ * ```
*/
getCurrentUser(): IUser {
return this._userManagerService.getCurrentUser();
diff --git a/packages/sheets/src/facade/f-range.ts b/packages/sheets/src/facade/f-range.ts
index be3b1e96da..fe2d57cc5c 100644
--- a/packages/sheets/src/facade/f-range.ts
+++ b/packages/sheets/src/facade/f-range.ts
@@ -225,11 +225,11 @@ export class FRange extends FBase {
// #region editing
/**
* Set background color for current range.
+ * @param color {string}
* @example
* ```
* univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackgroundColor('red')
* ```
- * @param color {string}
*/
setBackgroundColor(color: string): Promise<boolean> {
return this._commandService.executeCommand(SetStyleCommand.id, {
@@ -247,7 +247,10 @@ export class FRange extends FBase {
/**
* Set background color for current range.
- * e.g. `univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackground('red')`
+ * @example
+ * ```
+ * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackground('red')
+ * ```
* @param color {string}
*/
setBackground(color: string): Promise<boolean> {