251 lines
3.8 KiB
HTML
251 lines
3.8 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of Builtin_attributes</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>Builtin_attributes</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>
|
|
|
|
Builtin_attributes - Support for some of the builtin attributes
|
|
<A NAME="lbAC"> </A>
|
|
<H2>Module</H2>
|
|
|
|
Module Builtin_attributes
|
|
<A NAME="lbAD"> </A>
|
|
<H2>Documentation</H2>
|
|
|
|
<P>
|
|
Module
|
|
<B>Builtin_attributes</B>
|
|
|
|
<BR> :
|
|
<B>sig end</B>
|
|
|
|
<P>
|
|
<P>
|
|
Support for some of the builtin attributes
|
|
<P>
|
|
<P>
|
|
-ocaml.deprecated
|
|
<P>
|
|
-ocaml.alert
|
|
<P>
|
|
-ocaml.error
|
|
<P>
|
|
-ocaml.ppwarning
|
|
<P>
|
|
-ocaml.warning
|
|
<P>
|
|
-ocaml.warnerror
|
|
<P>
|
|
-ocaml.explicit_arity (for camlp4/camlp5)
|
|
<P>
|
|
-ocaml.warn_on_literal_pattern
|
|
<P>
|
|
-ocaml.deprecated_mutable
|
|
<P>
|
|
-ocaml.immediate
|
|
<P>
|
|
-ocaml.boxed / ocaml.unboxed
|
|
<P>
|
|
Warning: this module is unstable and part of
|
|
<B>Compiler_libs</B>
|
|
|
|
.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val check_alerts </I>
|
|
|
|
:
|
|
<B>Location.t -> Parsetree.attributes -> string -> unit</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val check_alerts_inclusion </I>
|
|
|
|
:
|
|
<B>def:Location.t -></B>
|
|
|
|
<B>use:Location.t -></B>
|
|
|
|
<B>Location.t -> Parsetree.attributes -> Parsetree.attributes -> string -> unit</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val alerts_of_attrs </I>
|
|
|
|
:
|
|
<B>Parsetree.attributes -> string Misc.Stdlib.String.Map.t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val alerts_of_sig </I>
|
|
|
|
:
|
|
<B>Parsetree.signature -> string Misc.Stdlib.String.Map.t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val alerts_of_str </I>
|
|
|
|
:
|
|
<B>Parsetree.structure -> string Misc.Stdlib.String.Map.t</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val check_deprecated_mutable </I>
|
|
|
|
:
|
|
<B>Location.t -> Parsetree.attributes -> string -> unit</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val check_deprecated_mutable_inclusion </I>
|
|
|
|
:
|
|
<B>def:Location.t -></B>
|
|
|
|
<B>use:Location.t -></B>
|
|
|
|
<B>Location.t -> Parsetree.attributes -> Parsetree.attributes -> string -> unit</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val check_no_alert </I>
|
|
|
|
:
|
|
<B>Parsetree.attributes -> unit</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val error_of_extension </I>
|
|
|
|
:
|
|
<B>Parsetree.extension -> Location.error</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val warning_attribute </I>
|
|
|
|
:
|
|
<B>?ppwarning:bool -> Parsetree.attribute -> unit</B>
|
|
|
|
<P>
|
|
Apply warning settings from the specified attribute.
|
|
"ocaml.warning"/"ocaml.warnerror" (and variants without the prefix)
|
|
are processed and other attributes are ignored.
|
|
<P>
|
|
Also implement ocaml.ppwarning (unless ~ppwarning:false is
|
|
passed).
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val warning_scope </I>
|
|
|
|
:
|
|
<B>?ppwarning:bool -> Parsetree.attributes -> (unit -> 'a) -> 'a</B>
|
|
|
|
<P>
|
|
Execute a function in a new scope for warning settings. This
|
|
means that the effect of any call to
|
|
<B>warning_attribute</B>
|
|
|
|
during
|
|
the execution of this function will be discarded after
|
|
execution.
|
|
<P>
|
|
The function also takes a list of attributes which are processed
|
|
with
|
|
<B>warning_attribute</B>
|
|
|
|
in the fresh scope before the function
|
|
is executed.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val warn_on_literal_pattern </I>
|
|
|
|
:
|
|
<B>Parsetree.attributes -> bool</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val explicit_arity </I>
|
|
|
|
:
|
|
<B>Parsetree.attributes -> bool</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val immediate </I>
|
|
|
|
:
|
|
<B>Parsetree.attributes -> bool</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val has_unboxed </I>
|
|
|
|
:
|
|
<B>Parsetree.attributes -> bool</B>
|
|
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<I>val has_boxed </I>
|
|
|
|
:
|
|
<B>Parsetree.attributes -> bool</B>
|
|
|
|
<P>
|
|
<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>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:37 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|