diff runtime/doc/sign.txt @ 17998:ea916dbbb9b9 v8.1.1995

patch 8.1.1995: more functions can be used as methods Commit: https://github.com/vim/vim/commit/93476fd6343ef40d088e064289cc279659d03953 Author: Bram Moolenaar <Bram@vim.org> Date: Fri Sep 6 22:00:54 2019 +0200 patch 8.1.1995: more functions can be used as methods Problem: More functions can be used as methods. Solution: Make sign functions usable as a method.
author Bram Moolenaar <Bram@vim.org>
date Fri, 06 Sep 2019 22:15:03 +0200
parents e414281d8bb4
children 834b7854aa3c
line wrap: on
line diff
--- a/runtime/doc/sign.txt
+++ b/runtime/doc/sign.txt
@@ -389,6 +389,9 @@ sign_define({list})
 				\  'text' : '!!'}
 				\ ])
 <
+		Can also be used as a |method|: >
+			GetSignList()->sign_define()
+
 sign_getdefined([{name}])				*sign_getdefined()*
 		Get a list of defined signs and their attributes.
 		This is similar to the |:sign-list| command.
@@ -417,6 +420,9 @@ sign_getdefined([{name}])				*sign_getde
 			" Get the attribute of the sign named mySign
 			echo sign_getdefined("mySign")
 <
+		Can also be used as a |method|: >
+			GetSignList()->sign_getdefined()
+
 sign_getplaced([{expr} [, {dict}]])			*sign_getplaced()*
 		Return a list of signs placed in a buffer or all the buffers.
 		This is similar to the |:sign-place-list| command.
@@ -477,6 +483,9 @@ sign_getplaced([{expr} [, {dict}]])			*s
 			" Get a List of all the placed signs
 			echo sign_getplaced()
 <
+		Can also be used as a |method|: >
+			GetBufname()->sign_getplaced()
+<
 							*sign_jump()*
 sign_jump({id}, {group}, {expr})
 		Open the buffer {expr} or jump to the window that contains
@@ -492,7 +501,9 @@ sign_jump({id}, {group}, {expr})
 			" Jump to sign 10 in the current buffer
 			call sign_jump(10, '', '')
 <
-
+		Can also be used as a |method|: >
+			GetSignid()->sign_jump()
+<
 							*sign_place()*
 sign_place({id}, {group}, {name}, {expr} [, {dict}])
 		Place the sign defined as {name} at line {lnum} in file or
@@ -542,7 +553,9 @@ sign_place({id}, {group}, {name}, {expr}
 			call sign_place(10, 'g3', 'sign4', 'json.c',
 					\ {'lnum' : 40, 'priority' : 90})
 <
-
+		Can also be used as a |method|: >
+			GetSignid()->sign_place(group, name, expr)
+<
 							*sign_placelist()*
 sign_placelist({list})
 		Place one or more signs.  This is similar to the
@@ -602,6 +615,8 @@ sign_placelist({list})
 				\  'lnum' : 50}
 				\ ])
 <
+		Can also be used as a |method|: >
+			GetSignlist()->sign_placelist()
 
 sign_undefine([{name}])					*sign_undefine()*
 sign_undefine({list})
@@ -626,6 +641,8 @@ sign_undefine({list})
 			" Delete all the signs
 			call sign_undefine()
 <
+		Can also be used as a |method|: >
+			GetSignlist()->sign_undefine()
 
 sign_unplace({group} [, {dict}])			*sign_unplace()*
 		Remove a previously placed sign in one or more buffers.  This
@@ -668,6 +685,9 @@ sign_unplace({group} [, {dict}])			*sign
 
 			" Remove all the placed signs from all the buffers
 			call sign_unplace('*')
+
+<		Can also be used as a |method|: >
+			GetSigngroup()->sign_unplace()
 <
 sign_unplacelist({list})				*sign_unplacelist()*
 		Remove previously placed signs from one or more buffers.  This
@@ -697,5 +717,8 @@ sign_unplacelist({list})				*sign_unplac
 				\ {'id' : 20, 'buffer' : 'b.vim'},
 				\ ])
 <
+		Can also be used as a |method|: >
+			GetSignlist()->sign_unplacelist()
+<
 
  vim:tw=78:ts=8:noet:ft=help:norl: