1Docstrings.WithMenhir(3)         OCaml library        Docstrings.WithMenhir(3)
2
3
4

NAME

6       Docstrings.WithMenhir - no description
7

Module

9       Module   Docstrings.WithMenhir
10

Documentation

12       Module WithMenhir
13        : sig end
14
15
16
17
18
19
20
21
22       val symbol_docs : Lexing.position * Lexing.position -> Docstrings.docs
23
24       Fetch  the  item  documentation for the current symbol. This also marks
25       this documentation (for ambiguity warnings).
26
27
28
29       val  symbol_docs_lazy  :  Lexing.position  *  Lexing.position  ->  Doc‐
30       strings.docs Lazy.t
31
32
33
34
35       val rhs_docs : Lexing.position -> Lexing.position -> Docstrings.docs
36
37       Fetch  the  item  documentation  for the symbols between two positions.
38       This also marks this documentation (for ambiguity warnings).
39
40
41
42       val  rhs_docs_lazy  :  Lexing.position  ->  Lexing.position   ->   Doc‐
43       strings.docs Lazy.t
44
45
46
47
48       val mark_symbol_docs : Lexing.position * Lexing.position -> unit
49
50       Mark the item documentation for the current symbol (for ambiguity warn‐
51       ings).
52
53
54
55       val mark_rhs_docs : Lexing.position -> Lexing.position -> unit
56
57       Mark as associated the item documentation for the symbols  between  two
58       positions (for ambiguity warnings)
59
60
61
62       val symbol_info : Lexing.position -> Docstrings.info
63
64       Fetch the field info for the current symbol.
65
66
67
68       val rhs_info : Lexing.position -> Docstrings.info
69
70       Fetch the field info following the symbol at a given position.
71
72
73
74       val symbol_text : Lexing.position -> Docstrings.text
75
76       Fetch the text preceding the current symbol.
77
78
79
80       val symbol_text_lazy : Lexing.position -> Docstrings.text Lazy.t
81
82
83
84
85       val rhs_text : Lexing.position -> Docstrings.text
86
87       Fetch the text preceding the symbol at the given position.
88
89
90
91       val rhs_text_lazy : Lexing.position -> Docstrings.text Lazy.t
92
93
94
95
96
97   Extra text
98       There  may  be  additional  text  attached to the delimiters of a block
99       (e.g.  struct and end ). This is fetched by  the  following  functions,
100       which  are  applied to the contents of the block rather than the delim‐
101       iters.
102
103       val symbol_pre_extra_text : Lexing.position -> Docstrings.text
104
105       Fetch additional text preceding the current symbol
106
107
108
109       val symbol_post_extra_text : Lexing.position -> Docstrings.text
110
111       Fetch additional text following the current symbol
112
113
114
115       val rhs_pre_extra_text : Lexing.position -> Docstrings.text
116
117       Fetch additional text preceding the symbol at the given position
118
119
120
121       val rhs_post_extra_text : Lexing.position -> Docstrings.text
122
123       Fetch additional text following the symbol at the given position
124
125
126
127       val rhs_post_text : Lexing.position -> Docstrings.text
128
129       Fetch text following the symbol at the given position
130
131
132
133
134
135OCamldoc                          2023-07-20          Docstrings.WithMenhir(3)