Skip to content

Commit

Permalink
add jsdoc for the options
Browse files Browse the repository at this point in the history
  • Loading branch information
akoreman committed Aug 21, 2024
1 parent 2f97d72 commit 6df00d1
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/marker_group.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ Potential improvements:
class MarkerGroup {
/**
* @param {EditSession} session
* @param {{markerType: "fullLine" | "line" | undefined}} [options]
* @param {{markerType: "fullLine" | "line" | undefined}} [options] Options controlling the behvaiour of the marker.
* User `markerType` to control how the markers which are part of this group will be rendered:
* - `undefined`: uses `text` type markers where only text characters within the range will be highlighted.
* - `fullLine`: will fully highlight all the rows within the range, including the characters before and after the range on the respective rows.
* - `line`: will fully highlight the lines within the range but will only cover the characters between the start and end of the range.
*/
constructor(session, options) {
if (options)
Expand Down

0 comments on commit 6df00d1

Please sign in to comment.