Update docs for insertTitle()

mermaid-js · Oct 23, 2022 · ccd88c8 · ccd88c8
1 parent 1720f6c
commit ccd88c8
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/packages/mermaid/src/utils.ts b/packages/mermaid/src/utils.ts
@@ -891,10 +891,10 @@ export function getErrorMessage(error: unknown): string {
 /**
  * Appends <text> element with the given title, centered.
  *
- * @param {any} parent d3 svg object to append title to
- * @param {string} cssClass
- * @param {number} titleTopMargin
- * @param {string | undefined} title
+ * @param parent - d3 svg object to append title to
+ * @param cssClass - CSS class for the <text> element containing the title
+ * @param titleTopMargin - Margin in pixels between title and rest of the graph
+ * @param title - The title. If empty, returns immediately.
  */
 export const insertTitle = (
   parent,