nixvim docs

plugins.comment-box.settings

Options provided to the require('comment-box').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  borders = {
    bottom_left = "X";
    bottom_right = "X";
    top_left = "X";
    top_right = "X";
  };
  box_width = 120;
  comment_style = "block";
  doc_width = 100;
  inner_blank_lines = true;
  line_width = 40;
  lines = {
    line = "*";
  };
  outer_blank_lines_below = true;
}

Declared by:

• <nixvim/plugins/by-name/comment-box>

plugins.comment-box.settings.box_width

Width of the boxes.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 60

Declared by:

• <nixvim/plugins/by-name/comment-box>

plugins.comment-box.settings.comment_style

Select the type of comments.

Type: null or one of “line”, “block”, “auto” or raw lua code

Default: null

Plugin default: "line"

Declared by:

• <nixvim/plugins/by-name/comment-box>

plugins.comment-box.settings.doc_width

Width of the document.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 80

Declared by:

• <nixvim/plugins/by-name/comment-box>

plugins.comment-box.settings.line_width

Width of the lines.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 70

Declared by:

• <nixvim/plugins/by-name/comment-box>