Updated Lua apidoc; modules/lua/api

1 files changed, 4 insertions, 4 deletions

diff --git a/modules/lua/api b/modules/lua/api
index 1ccacac3..031c0d97 100644
--- a/modules/lua/api
+++ b/modules/lua/api
@@ -1072,7 +1072,7 @@ indentation_guides buffer.indentation_guides [number]\nIndentation guides appear
 indic_alpha buffer.indic_alpha [table]\nTable of alpha transparency values ranging from 0 (transparent) to 255\n(opaque) or 256 (no alpha) for indicators from 0 to 31. Used for drawing\nthe fill color of the `INDIC_ROUNDBOX` and `INDIC_STRAIGHTBOX` rectangle.\n
 indic_fore buffer.indic_fore [table]\nTable of foreground colors in 0xBBGGRR format for indicators from zero to 31.\n
 indic_outline_alpha buffer.indic_outline_alpha [table]\nTable of alpha transparency values ranging from 0 (transparent) to 255\n(opaque) or 256 (no alpha) for indicators from 0 to 31. Used for drawing\nthe outline color of the `INDIC_ROUNDBOX` and `INDIC_STRAIGHTBOX` rectangle.\n
-indic_style buffer.indic_style [table]\nTable of styles for indicators from zero to 31.\n    * `_SCINTILLA.constants.INDIC_PLAIN` (0): Underlined with a single,\n      straight line.\n    * `_SCINTILLA.constants.INDIC_SQUIGGLE` (1): A squiggly underline.\n      Requires 3 pixels of descender space.\n    * `_SCINTILLA.constants.INDIC_TT` (2): A line of small T shapes.\n    * `_SCINTILLA.constants.INDIC_DIAGONAL` (3): Diagonal hatching.\n    * `_SCINTILLA.constants.INDIC_STRIKE` (4): Strike out.\n    * `_SCINTILLA.constants.INDIC_HIDDEN` (5): An indicator with no visual\n      effect.\n    * `_SCINTILLA.constants.INDIC_BOX` (6): A rectangle around the text.\n    * `_SCINTILLA.constants.INDIC_ROUNDBOX` (7): A rectangle with rounded\n      corners around the text using translucent drawing with the interior\n      usually more transparent than the border. Use `buffer.indic_alpha`\n      and `buffer.indic_outline_alpha` to control the alpha transparency\n      values. The default alpha values are 30 for fill color and 50 for\n      outline color.\n    * `_SCINTILLA.constants.INDIC_STRAIGHTBOX` (8): A rectangle around the\n      text using translucent drawing with the interior usually more\n      transparent than the border. You can use `buffer.indic_alpha` and\n      `buffer.indic_outline_alpha` to control the alpha transparency\n      values. The default alpha values are 30 for fill color and 50 for\n      outline color.\n    * `_SCINTILLA.constants.INDIC_DASH` (9): A dashed underline.\n    * `_SCINTILLA.constants.INDIC_DOTS` (10): A dotted underline.\n    * `_SCINTILLA.constants.INDIC_SQUIGGLELOW` (11): Similar to\n      `INDIC_SQUIGGLE` but only using 2 vertical pixels so will fit under\n      small fonts.\n    * `_SCINTILLA.constants.INDIC_DOTBOX` (12): A dotted rectangle around\n      the text using translucent drawing. Translucency alternates between\n      the alpha and outline alpha settings with the top-left pixel using\n      the alpha setting. `buffer.indic_alpha` and\n      `buffer.indic_outline_alpha` control the alpha transparency values.\n      The default values are 30 for alpha and 50 for outline alpha. To\n      avoid excessive memory allocation the maximum width of a dotted box\n      is 4000 pixels.\n\n
+indic_style buffer.indic_style [table]\nTable of styles for indicators from zero to 31.\n    * `_SCINTILLA.constants.INDIC_PLAIN` (0): Underlined with a single,\n      straight line.\n    * `_SCINTILLA.constants.INDIC_SQUIGGLE` (1): A squiggly underline.\n      Requires 3 pixels of descender space.\n    * `_SCINTILLA.constants.INDIC_TT` (2): A line of small T shapes.\n    * `_SCINTILLA.constants.INDIC_DIAGONAL` (3): Diagonal hatching.\n    * `_SCINTILLA.constants.INDIC_STRIKE` (4): Strike out.\n    * `_SCINTILLA.constants.INDIC_HIDDEN` (5): An indicator with no visual\n      effect.\n    * `_SCINTILLA.constants.INDIC_BOX` (6): A rectangle around the text.\n    * `_SCINTILLA.constants.INDIC_ROUNDBOX` (7): A rectangle with rounded\n      corners around the text using translucent drawing with the interior\n      usually more transparent than the border. Use `buffer.indic_alpha`\n      and `buffer.indic_outline_alpha` to control the alpha transparency\n      values. The default alpha values are 30 for fill color and 50 for\n      outline color.\n    * `_SCINTILLA.constants.INDIC_STRAIGHTBOX` (8): A rectangle around the\n      text using translucent drawing with the interior usually more\n      transparent than the border. You can use `buffer.indic_alpha` and\n      `buffer.indic_outline_alpha` to control the alpha transparency\n      values. The default alpha values are 30 for fill color and 50 for\n      outline color.\n    * `_SCINTILLA.constants.INDIC_DASH` (9): A dashed underline.\n    * `_SCINTILLA.constants.INDIC_DOTS` (10): A dotted underline.\n    * `_SCINTILLA.constants.INDIC_SQUIGGLELOW` (11): Similar to\n      `INDIC_SQUIGGLE` but only using 2 vertical pixels so will fit under\n      small fonts.\n    * `_SCINTILLA.constants.INDIC_DOTBOX` (12): A dotted rectangle around\n      the text using translucent drawing. Translucency alternates between\n      the alpha and outline alpha settings with the top-left pixel using\n      the alpha setting. `buffer.indic_alpha` and\n      `buffer.indic_outline_alpha` control the alpha transparency values.\n      The default values are 30 for alpha and 50 for outline alpha. To\n      avoid excessive memory allocation the maximum width of a dotted box\n      is 4000 pixels.\n    * Use `_SCINTILLA.next_indic_number()` for custom indicators.\n\n
 indic_under buffer.indic_under [table]\nTable of booleans for drawing under text or over (default) for indicators\nfrom zero to 31.\n
 indicator_all_on_for buffer.indicator_all_on_for(buffer, pos)\nRetrieve a bitmap value representing which indicators are non-zero at a\nposition. Bit 0 is set if indicator 0 is present, bit 1 for indicator 1 and\nso on.\n@param buffer The focused buffer.\n@param pos The position.\n@return number\n
 indicator_clear_range buffer.indicator_clear_range(buffer, pos, clear_length)\nTurn a indicator off over a range.\n@param buffer The focused buffer.\n@param pos The start position.\n@param clear_length The length.\n
@@ -1182,7 +1182,7 @@ margin_type_n buffer.margin_type_n [table]\nTable of margin types for margins fr
 margin_width_n buffer.margin_width_n [table]\nTable of margin widths expressed in pixes for margins from zero to four.\n
 marker_add buffer.marker_add(buffer, line, marker_num)\nAdd a marker to a line, returning an ID which can be used to find or delete\nthe marker. Returns -1 if this fails (illegal line number, out of memory).\n@param buffer The focused buffer.\n@param line The line number.\n@param marker_num A marker number in the range of 0 to 31.\n@return number\n
 marker_add_set buffer.marker_add_set(buffer, line, marker_mask)\nAdd a set of markers to a line.\n@param buffer The focused buffer.\n@param line The line number.\n@param marker_mask A mask of markers to set. Set bit 0 to set marker 0,\nbit 1 for marker 1 and so on.\n
-marker_define buffer.marker_define(buffer, marker_num, marker_symbol)\nSet the symbol used for a particular marker number.\n@param buffer The focused buffer.\n@param marker_num A marker number in the range of 0 to 31.\n@param marker_symbol A marker symbol: _SCINTILLA.constants.SC_MARK_*.\n
+marker_define buffer.marker_define(buffer, marker_num, marker_symbol)\nSet the symbol used for a particular marker number.\n@param buffer The focused buffer.\n@param marker_num A marker number in the range of 0 to 31.\n@param marker_symbol A marker symbol: _SCINTILLA.constants.SC_MARK_*.\n@see _SCINTILLA.next_marker_number\n
 marker_define_pixmap buffer.marker_define_pixmap(buffer, marker_num, pixmap)\nDefine a marker from a pixmap.\n@param buffer The focused buffer.\n@param marker_num A marker number in the range of 0 to 31.\n@param pixmap Null-terminated pixmap data.\n
 marker_define_rgba_image buffer.marker_define_rgba_image(buffer, marker_num, pixels)\nDefine a marker from RGBA data. It has the width and height from\n`buffer.rgba_image_width` and `buffer.rgba_image_height`.\n@param buffer The focused buffer.\n@param marker_num A marker number in the range of 0 to 31.\n@param pixels A sequence of 4 byte pixel values starting with the pixels\nfor the top line, with the leftmost pixel first, then continuing with the\npixels for subsequent lines. There is no gap between lines for alignment\nreasons. Each pixel consists of, in order, a red byte, a green byte, a blue\nbyte and an alpha byte. The colour bytes are not premultiplied by the alpha\nvalue. That is, a fully red pixel that is 25% opaque will be [FF, 00, 00, 3F].\n
 marker_delete buffer.marker_delete(buffer, line, marker_num)\nDelete a marker from a line.\n@param buffer The focused buffer.\n@param line The line number.\n@param marker_num A marker number in the range of 0 to 31 or -1 to delete\nall markers from the line.\n
@@ -1229,7 +1229,7 @@ new_buffer _G.new_buffer()\nCreates a new buffer. Activates the 'buffer_new' sig
 new_line buffer.new_line(buffer)\nInsert a new line, may use a CRLF, CR or LF depending on EOL mode.\n@param buffer The focused buffer.\n
 newline lexer.newline\nMatches any newline characters.\n
 next _G.next(table [, index])\nAllows a program to traverse all fields of a table. Its first argument is\na table and its second argument is an index in this table. `next` returns\nthe next index of the table and its associated value. When called with nil\nas its second argument, `next` returns an initial index and its associated\nvalue. When called with the last index, or with nil in an empty table,\n`next` returns nil. If the second argument is absent, then it is interpreted\nas nil. In particular, you can use `next(t)` to check whether a table is\nempty. The order in which the indices are enumerated is not specified, *even\nfor numeric indices*. (To traverse a table in numeric order, use a numerical\nfor or the `ipairs` function.) The behavior of `next` is *undefined* if,\nduring the traversal, you assign any value to a non-existent field in the\ntable. You may however modify existing fields. In particular, you may clear\nexisting fields.\n
-next_indic_number _SCINTILLA.next_indic_number()\nReturns a unique indicator number. Use this function for custom indicators\nin order to prevent clashes with identifiers of other custom indicators.\n@usage local indic_num = _SCINTILLA.next_indic_number()\n
+next_indic_number _SCINTILLA.next_indic_number()\nReturns a unique indicator number. Use this function for custom indicators\nin order to prevent clashes with identifiers of other custom indicators.\n@usage local indic_num = _SCINTILLA.next_indic_number()\n@see buffer.indic_style\n
 next_marker_number _SCINTILLA.next_marker_number()\nReturns a unique marker number. Use this function for custom markers in\norder to prevent clashes with identifiers of other custom markers.\n@usage local marknum = _SCINTILLA.next_marker_number()\n@see buffer.marker_define\n
 next_user_list_type _SCINTILLA.next_user_list_type()\nReturns a unique user list type. Use this function for custom user lists in\norder to prevent clashes with type identifiers of other custom user lists.\n@usage local list_type = _SCINTILLA.next_user_list_type()\n@see buffer.user_list_show\n
 nonnewline lexer.nonnewline\nMatches any non-newline character.\n
@@ -1568,7 +1568,7 @@ upper_case buffer.upper_case(buffer)\nTransform the selection to upper case.\n@p
 use_pop_up buffer.use_pop_up(buffer, allow_popup)\nSets whether a pop up menu is displayed automatically when the user presses\nthe wrong mouse button.\n@param buffer The focused buffer.\n@param allow_popup Allow popup menu.\n
 use_tabs buffer.use_tabs [bool]\nWhether tabs will be used in indentation. The default is `true`. `false`\nwill only use space characters.\n
 user_dofile _G.user_dofile(filename)\nCalls 'dofile' on the given filename in the user's Textadept directory. This\nis typically used for loading user files like key commands or snippets. Errors\nare printed to the Textadept message buffer.\n@param filename The name of the file (not path).\n@return true if successful; false otherwise.\n
-user_list_show buffer.user_list_show(buffer, list_type, item_list)\nDisplay a list of strings and send notification when user chooses one.\n@param buffer The focused buffer.\n@param list_type A list identifier number greater than zero.\n@param item_list List of words separated by separator characters (initially\nspaces).\n
+user_list_show buffer.user_list_show(buffer, list_type, item_list)\nDisplay a list of strings and send notification when user chooses one.\n@param buffer The focused buffer.\n@param list_type A list identifier number greater than zero.\n@param item_list List of words separated by separator characters (initially\nspaces).\n@see _SCINTILLA.next_user_list_type\n
 v_scroll_bar buffer.v_scroll_bar [bool]\nWhether the vertical scroll bar is visible. Set to `false` to never see it and\n`true` to enable it again. The default state is to display it when required.\n
 vc_home buffer.vc_home(buffer)\nMove caret to before first visible character on line. If already there move\nto first character on line.\n@param buffer The focused buffer.\n
 vc_home_extend buffer.vc_home_extend(buffer)\nLike `buffer:vc_home()` but extending selection to new caret position.\n@param buffer The focused buffer.\n