247 lines
3.9 KiB
HTML
247 lines
3.9 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of Docstrings.WithMenhir</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>Docstrings.WithMenhir</H1>
|
|
Section: OCaml library (3o)<BR>Updated: 2020-01-30<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
Docstrings.WithMenhir - no description
|
|
<A NAME="lbAC"> </A>
|
|
<H2>Module</H2>
|
|
|
|
Module Docstrings.WithMenhir
|
|
<A NAME="lbAD"> </A>
|
|
<H2>Documentation</H2>
|
|
|
|
<P>
|
|
Module
|
|
<B>WithMenhir</B>
|
|
|
|
<BR> :
|
|
<B>sig end</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val symbol_docs </I>
|
|
|
|
:
|
|
<B>Lexing.position * Lexing.position -> Docstrings.docs</B>
|
|
|
|
<P>
|
|
Fetch the item documentation for the current symbol. This also
|
|
marks this documentation (for ambiguity warnings).
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val symbol_docs_lazy </I>
|
|
|
|
:
|
|
<B>Lexing.position * Lexing.position -></B>
|
|
|
|
<B>Docstrings.docs Lazy.t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val rhs_docs </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Lexing.position -> Docstrings.docs</B>
|
|
|
|
<P>
|
|
Fetch the item documentation for the symbols between two
|
|
positions. This also marks this documentation (for ambiguity
|
|
warnings).
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val rhs_docs_lazy </I>
|
|
|
|
:
|
|
<B>Lexing.position -></B>
|
|
|
|
<B>Lexing.position -> Docstrings.docs Lazy.t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val mark_symbol_docs </I>
|
|
|
|
:
|
|
<B>Lexing.position * Lexing.position -> unit</B>
|
|
|
|
<P>
|
|
Mark the item documentation for the current symbol (for ambiguity
|
|
warnings).
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val mark_rhs_docs </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Lexing.position -> unit</B>
|
|
|
|
<P>
|
|
Mark as associated the item documentation for the symbols between
|
|
two positions (for ambiguity warnings)
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val symbol_info </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Docstrings.info</B>
|
|
|
|
<P>
|
|
Fetch the field info for the current symbol.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val rhs_info </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Docstrings.info</B>
|
|
|
|
<P>
|
|
Fetch the field info following the symbol at a given position.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val symbol_text </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Docstrings.text</B>
|
|
|
|
<P>
|
|
Fetch the text preceding the current symbol.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val symbol_text_lazy </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Docstrings.text Lazy.t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val rhs_text </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Docstrings.text</B>
|
|
|
|
<P>
|
|
Fetch the text preceding the symbol at the given position.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val rhs_text_lazy </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Docstrings.text Lazy.t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H3>Extra text</H3>
|
|
|
|
<P>
|
|
There may be additional text attached to the delimiters of a block
|
|
(e.g.
|
|
<B>struct</B>
|
|
|
|
and
|
|
<B>end</B>
|
|
|
|
). This is fetched by the following
|
|
functions, which are applied to the contents of the block rather
|
|
than the delimiters.
|
|
<P>
|
|
|
|
<P>
|
|
<I>val symbol_pre_extra_text </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Docstrings.text</B>
|
|
|
|
<P>
|
|
Fetch additional text preceding the current symbol
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val symbol_post_extra_text </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Docstrings.text</B>
|
|
|
|
<P>
|
|
Fetch additional text following the current symbol
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val rhs_pre_extra_text </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Docstrings.text</B>
|
|
|
|
<P>
|
|
Fetch additional text preceding the symbol at the given position
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val rhs_post_extra_text </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Docstrings.text</B>
|
|
|
|
<P>
|
|
Fetch additional text following the symbol at the given position
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val rhs_post_text </I>
|
|
|
|
:
|
|
<B>Lexing.position -> Docstrings.text</B>
|
|
|
|
<P>
|
|
Fetch text following the symbol at the given position
|
|
<P>
|
|
<P>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="2"><A HREF="#lbAC">Module</A><DD>
|
|
<DT id="3"><A HREF="#lbAD">Documentation</A><DD>
|
|
<DL>
|
|
<DT id="4"><A HREF="#lbAE">Extra text</A><DD>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:38 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|