1Docstrings(3) OCaml library Docstrings(3)
2
6 Docstrings - Documentation comments
7
9 Module Docstrings
10
12 Module Docstrings
13 : sig end
14 Documentation comments
17 Warning: this module is unstable and part of Compiler_libs .
19 val init : unit -> unit
26 (Re)Initialise all docstring state
28 val warn_bad_docstrings : unit -> unit
32 Emit warnings for unattached and ambiguous docstrings
34 Docstrings
39 type docstring
40 Documentation comments
43 val docstring : string -> Location.t -> docstring
47 Create a docstring
49 val register : docstring -> unit
53 Register a docstring
55 val docstring_body : docstring -> string
59 Get the text of a docstring
61 val docstring_loc : docstring -> Location.t
65 Get the location of a docstring
67 Set functions
72 These functions are used by the lexer to associate docstrings to the
73 locations of tokens.
74 val set_pre_docstrings : Lexing.position -> docstring list -> unit
76 Docstrings immediately preceding a token
78 val set_post_docstrings : Lexing.position -> docstring list -> unit
82 Docstrings immediately following a token
84 val set_floating_docstrings : Lexing.position -> docstring list -> unit
88 Docstrings not immediately adjacent to a token
90 val set_pre_extra_docstrings : Lexing.position -> docstring list ->
94 unit
95 Docstrings immediately following the token which precedes this one
97 val set_post_extra_docstrings : Lexing.position -> docstring list ->
101 unit
102 Docstrings immediately preceding the token which follows this one
104 Items
109 The Docstrings.docs type represents documentation attached to an item.
110 type docs = {
112 docs_pre : docstring option ;
113 docs_post : docstring option ;
114 }
115 val empty_docs : docs
121 val docs_attr : docstring -> Parsetree.attribute
126 val add_docs_attrs : docs -> Parsetree.attributes -> Parsetree.at‐
131 tributes
132 Convert item documentation to attributes and add them to an attribute
134 list
135 val symbol_docs : unit -> docs
139 Fetch the item documentation for the current symbol. This also marks
141 this documentation (for ambiguity warnings).
142 val symbol_docs_lazy : unit -> docs Lazy.t
146 val rhs_docs : int -> int -> docs
151 Fetch the item documentation for the symbols between two positions.
153 This also marks this documentation (for ambiguity warnings).
154 val rhs_docs_lazy : int -> int -> docs Lazy.t
158 val mark_symbol_docs : unit -> unit
163 Mark the item documentation for the current symbol (for ambiguity warn‐
165 ings).
166 val mark_rhs_docs : int -> int -> unit
170 Mark as associated the item documentation for the symbols between two
172 positions (for ambiguity warnings)
173 Fields and constructors
178 The Docstrings.info type represents documentation attached to a field
179 or constructor.
180 type info = docstring option
182 val empty_info : info
188 val info_attr : docstring -> Parsetree.attribute
193 val add_info_attrs : info -> Parsetree.attributes -> Parsetree.at‐
198 tributes
199 Convert field info to attributes and add them to an attribute list
201 val symbol_info : unit -> info
205 Fetch the field info for the current symbol.
207 val rhs_info : int -> info
211 Fetch the field info following the symbol at a given position.
213 Unattached comments
218 The Docstrings.text type represents documentation which is not attached
219 to anything.
220 type text = docstring list
222 val empty_text : text
228 val empty_text_lazy : text Lazy.t
233 val text_attr : docstring -> Parsetree.attribute
238 val add_text_attrs : text -> Parsetree.attributes -> Parsetree.at‐
243 tributes
244 Convert text to attributes and add them to an attribute list
246 val symbol_text : unit -> text
250 Fetch the text preceding the current symbol.
252 val symbol_text_lazy : unit -> text Lazy.t
256 val rhs_text : int -> text
261 Fetch the text preceding the symbol at the given position.
263 val rhs_text_lazy : int -> text Lazy.t
267 Extra text
273 There may be additional text attached to the delimiters of a block
274 (e.g. struct and end ). This is fetched by the following functions,
275 which are applied to the contents of the block rather than the delim‐
276 iters.
277 val symbol_pre_extra_text : unit -> text
279 Fetch additional text preceding the current symbol
281 val symbol_post_extra_text : unit -> text
285 Fetch additional text following the current symbol
287 val rhs_pre_extra_text : int -> text
291 Fetch additional text preceding the symbol at the given position
293 val rhs_post_extra_text : int -> text
297 Fetch additional text following the symbol at the given position
299 val rhs_post_text : int -> text
303 Fetch text following the symbol at the given position
305 module WithMenhir : sig end
308OCamldoc 2021-07-22 Docstrings(3)