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 val init : unit -> unit
24 (Re)Initialise all docstring state
26 val warn_bad_docstrings : unit -> unit
30 Emit warnings for unattached and ambiguous docstrings
32 === Docstrings ===
37 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 These functions are used by the lexer to associate
72 docstrings to the locations of tokens. ===
73 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 The Docstrings.docs type represents documentation attached to
109 an item. ===
110 type docs = {
113 docs_pre : docstring option ;
114 docs_post : docstring option ;
115 }
116 val empty_docs : docs
122 val docs_attr : docstring -> Parsetree.attribute
127 val add_docs_attrs : docs -> Parsetree.attributes -> Parse‐
132 tree.attributes
133 Convert item documentation to attributes and add them to an attribute
135 list
136 val symbol_docs : unit -> docs
140 Fetch the item documentation for the current symbol. This also marks
142 this documentation (for ambiguity warnings).
143 val symbol_docs_lazy : unit -> docs Lazy.t
147 val rhs_docs : int -> int -> docs
152 Fetch the item documentation for the symbols between two positions.
154 This also marks this documentation (for ambiguity warnings).
155 val rhs_docs_lazy : int -> int -> docs Lazy.t
159 val mark_symbol_docs : unit -> unit
164 Mark the item documentation for the current symbol (for ambiguity warn‐
166 ings).
167 val mark_rhs_docs : int -> int -> unit
171 Mark as associated the item documentation for the symbols between two
173 positions (for ambiguity warnings)
174 === Fields and constructors The Docstrings.info type represents docu‐
179 mentation attached to a field or constructor. ===
180 type info = docstring option
183 val empty_info : info
189 val info_attr : docstring -> Parsetree.attribute
194 val add_info_attrs : info -> Parsetree.attributes -> Parse‐
199 tree.attributes
200 Convert field info to attributes and add them to an attribute list
202 val symbol_info : unit -> info
206 Fetch the field info for the current symbol.
208 val rhs_info : int -> info
212 Fetch the field info following the symbol at a given position.
214 === Unattached comments The Docstrings.text type represents documenta‐
219 tion which is not attached to anything. ===
220 type text = docstring list
223 val empty_text : text
229 val empty_text_lazy : text Lazy.t
234 val text_attr : docstring -> Parsetree.attribute
239 val add_text_attrs : text -> Parsetree.attributes -> Parse‐
244 tree.attributes
245 Convert text to attributes and add them to an attribute list
247 val symbol_text : unit -> text
251 Fetch the text preceding the current symbol.
253 val symbol_text_lazy : unit -> text Lazy.t
257 val rhs_text : int -> text
262 Fetch the text preceding the symbol at the given position.
264 val rhs_text_lazy : int -> text Lazy.t
268 === Extra text There may be additional text attached to the delimiters
274 of a block (e.g. struct and end). This is fetched by the following
275 functions, which are applied to the contents of the block rather than
276 the delimiters. ===
277 val symbol_pre_extra_text : unit -> text
280 Fetch additional text preceding the current symbol
282 val symbol_post_extra_text : unit -> text
286 Fetch additional text following the current symbol
288 val rhs_pre_extra_text : int -> text
292 Fetch additional text preceding the symbol at the given position
294 val rhs_post_extra_text : int -> text
298 Fetch additional text following the symbol at the given position
300 val rhs_post_text : int -> text
304 Fetch text following the symbol at the given position
306OCamldoc 2019-02-02 Docstrings(3)