ocaml-trace/ppxlib/Ppxlib/Driver/Create_file_property/index.html
2024-03-08 16:51:12 +00:00

2 lines
No EOL
2.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Create_file_property (ppxlib.Ppxlib.Driver.Create_file_property)</title><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../../index.html">ppxlib</a> &#x00BB; <a href="../../index.html">Ppxlib</a> &#x00BB; <a href="../index.html">Driver</a> &#x00BB; Create_file_property</nav><header class="odoc-preamble"><h1>Module <code><span>Driver.Create_file_property</span></code></h1><p>Create a new file property.</p><p>A file property represent a piece of information about a file that can be set during preprocessing. If the <code>-output-metadata FILE</code> command line option was passed to the driver, then it will output this information to the given file.</p><p>This mechanism is used to pass information gathered while preprocessing the file to the build system. For instance, this is used by ppx_inline_test to tell whether a file contains tests or not.</p><p>In the future we could also use this to directly compute the dependencies and pass them here, to avoid calling ocamldep separately.</p></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-Name"><a href="#argument-1-Name" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-Name/index.html">Name</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-2-T"><a href="#argument-2-T" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-2-T/index.html">T</a></span><span> : <a href="../../../../sexplib0/Sexplib0/Sexpable/module-type-S/index.html">Stdppx.Sexpable.S</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value anchored" id="val-set"><a href="#val-set" class="anchor"></a><code><span><span class="keyword">val</span> set : <span><a href="argument-2-T/index.html#type-t">T.t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>