@@ -2,8 +2,9 @@ use crate::Buffer;
2
2
use crate :: ToFunction ;
3
3
4
4
/// Arguments passed to the callback registered to
5
- /// [`on_lines`](BufAttachOptsBuilder::on_lines). The `(a, b, c, d, e, f, g, h,
6
- /// i)` tuple represents:
5
+ /// [`on_lines`](BufAttachOptsBuilder::on_lines).
6
+ ///
7
+ /// The `(a, b, c, d, e, f, g, h, i)` tuple represents:
7
8
///
8
9
/// - `a`: the string literal `"lines"`;
9
10
/// - `b`: the [`Buffer`] that triggered the callback;
@@ -28,7 +29,9 @@ pub type OnLinesArgs = (
28
29
Option < usize > ,
29
30
) ;
30
31
31
- /// Arguments passed to the callback registered to [`on_bytes`](BufAttachOptsBuilder::on_bytes). The `(a, b, c, d, e, f, g, h, i, j, k, l)`
32
+ /// Arguments passed to the callback registered to [`on_bytes`](BufAttachOptsBuilder::on_bytes).
33
+ ///
34
+ /// The `(a, b, c, d, e, f, g, h, i, j, k, l)`
32
35
/// - `a`: the string literal `"bytes"`;
33
36
/// - `b`: the [`Buffer`] that triggered the callback;
34
37
/// - `c`: the value of the buffer-local `b:changedtick` variable;
@@ -57,24 +60,27 @@ pub type OnBytesArgs = (
57
60
) ;
58
61
59
62
/// Arguments passed to the callback registered to
60
- /// [`on_changedtick`](BufAttachOptsBuilder::on_changedtick). The first tuple
61
- /// element is the string literal `"changedtick"`, the second is the [`Buffer`]
62
- /// that triggered the callback and the third is current value of the
63
- /// buffer-local
63
+ /// [`on_changedtick`](BufAttachOptsBuilder::on_changedtick).
64
+ ///
65
+ /// The first tuple element is the string literal `"changedtick"`, the second
66
+ /// is the [`Buffer`] that triggered the callback and the third is current
67
+ /// value of the buffer-local
64
68
/// [`b:changedtick`](https://neovim.io/doc/user/eval.html#b:changedtick)
65
69
/// variable.
66
70
pub type OnChangedtickArgs = ( String , Buffer , u32 ) ;
67
71
68
72
/// Arguments passed to the callback registered to
69
- /// [`on_detach`](BufAttachOptsBuilder::on_detach). The first tuple element is
70
- /// the string literal `"detach"`, the second is the [`Buffer`] that triggered
71
- /// the callback.
73
+ /// [`on_detach`](BufAttachOptsBuilder::on_detach).
74
+ ///
75
+ /// The first tuple element is the string literal `"detach"`, the second is the
76
+ /// [`Buffer`] that triggered the callback.
72
77
pub type OnDetachArgs = ( String , Buffer ) ;
73
78
74
79
/// Arguments passed to the callback registered to
75
- /// [`on_reload`](BufAttachOptsBuilder::on_reload). The first tuple element is
76
- /// the string literal `"reload"`, the second is the [`Buffer`] that triggered
77
- /// the callback.
80
+ /// [`on_reload`](BufAttachOptsBuilder::on_reload).
81
+ ///
82
+ /// The first tuple element is the string literal `"reload"`, the second is the
83
+ /// [`Buffer`] that triggered the callback.
78
84
pub type OnReloadArgs = ( String , Buffer ) ;
79
85
80
86
/// All the registered callbacks can detach by returning `true`, as described
0 commit comments