GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-14 06:43:25 +08:00
Code Issues Projects Releases Wiki Activity

Fixed outdated doc strings

Browse Source 
This commit fixes some outdated docstrings, replacing the description
and @params where necessary.
This commit is contained in:
Danny Shemesh 2020-04-23 07:23:50 +03:00
parent 10fdc45dea
commit 49f8aac6a9
3 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/diagrams/sequence/sequenceRenderer.js
View File

@ -186,10 +186,12 @@ const _drawLongText = (text, x, y, g, width) => {
}; };
/** /**
* Draws an actor in the diagram with the attaced line * Draws an note in the diagram with the attaced line
* @param center - The center of the the actor * @param elem - The diagram to draw to.
* @param pos The position if the actor in the liost of actors * @param startx - The x axis start position.
* @param description The text in the box * @param verticalPos - The y axis position.
* @param msg - The message to be drawn.
* @param forceWidth - Set this with a custom width to override the default configured width.
*/ */
const drawNote = function(elem, startx, verticalPos, msg, forceWidth) { const drawNote = function(elem, startx, verticalPos, msg, forceWidth) {
const rect = svgDraw.getNoteRect(); const rect = svgDraw.getNoteRect();

25
src/diagrams/sequence/svgDraw.js
View File

@ -73,9 +73,9 @@ export const drawLabel = function(elem, txtObject) {
let actorCnt = -1; let actorCnt = -1;
/** /**
* Draws an actor in the diagram with the attaced line * Draws an actor in the diagram with the attaced line
* @param center - The center of the the actor * @param elem - The diagram we'll draw to.
* @param pos The position if the actor in the liost of actors * @param actor - The actor to draw.
* @param description The text in the box * @param config - The sequence diagram config object.
*/ */
export const drawActor = function(elem, left, verticalPos, description, conf) { export const drawActor = function(elem, left, verticalPos, description, conf) {
const center = left + conf.width / 2; const center = left + conf.width / 2;
@ -120,10 +120,12 @@ export const anchorElement = function(elem) {
return elem.append('g'); return elem.append('g');
}; };
/** /**
* Draws an actor in the diagram with the attaced line * Draws an activation in the diagram
* @param elem - element to append activation rect * @param elem - element to append activation rect.
* @param bounds - activation box bounds * @param bounds - activation box bounds.
* @param verticalPos - precise y cooridnate of bottom activation box edge * @param verticalPos - precise y cooridnate of bottom activation box edge.
* @param conf - sequence diagram config object.
* @param actorActivations - number of activations on the actor.
*/ */
export const drawActivation = function(elem, bounds, verticalPos, conf, actorActivations) { export const drawActivation = function(elem, bounds, verticalPos, conf, actorActivations) {
const rect = getNoteRect(); const rect = getNoteRect();
@ -137,10 +139,11 @@ export const drawActivation = function(elem, bounds, verticalPos, conf, actorAct
}; };
/** /**
* Draws an actor in the diagram with the attaced line * Draws a loop in the diagram
* @param center - The center of the the actor * @param elem - elemenet to append the loop to.
* @param pos The position if the actor in the list of actors * @param bounds - bounds of the given loop.
* @param description The text in the box * @param labelText - Text within the loop.
* @param config - sequence diagram config object.
*/ */
export const drawLoop = function(elem, bounds, labelText, conf) { export const drawLoop = function(elem, bounds, labelText, conf) {
const g = elem.append('g'); const g = elem.append('g');

7
src/diagrams/state/shapes.js
View File

@ -333,10 +333,9 @@ const _drawLongText = (_text, x, y, g) => {
}; };
/** /**
* Draws an actor in the diagram with the attaced line * Draws a note to the diagram
* @param center - The center of the the actor * @param text - The text of the given note.
* @param pos The position if the actor in the liost of actors * @param g - The element the note is attached to.
* @param description The text in the box
*/ */
export const drawNote = (text, g) => { export const drawNote = (text, g) => {