<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="previous" href="CategoryName.html"> <link rel="next" href="OcamldocUtils.html"> <link rel="Up" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Index of module types" rel=Appendix href="index_module_types.html"> <link title="IgnoreParser" rel="Chapter" href="IgnoreParser.html"> <link title="ConfigParser" rel="Chapter" href="ConfigParser.html"> <link title="IgnoreLexer" rel="Chapter" href="IgnoreLexer.html"> <link title="ConfigLexer" rel="Chapter" href="ConfigLexer.html"> <link title="CategoryName" rel="Chapter" href="CategoryName.html"> <link title="OutputName" rel="Chapter" href="OutputName.html"> <link title="OcamldocUtils" rel="Chapter" href="OcamldocUtils.html"> <link title="Annotation" rel="Chapter" href="Annotation.html"> <link title="Ignore" rel="Chapter" href="Ignore.html"> <link title="Utils" rel="Chapter" href="Utils.html"> <link title="Report" rel="Chapter" href="Report.html"> <link title="Images" rel="Chapter" href="Images.html"> <link title="Output" rel="Chapter" href="Output.html"> <link title="ParameterName" rel="Chapter" href="ParameterName.html"> <link title="Ocamldep" rel="Chapter" href="Ocamldep.html"> <link title="Cache" rel="Chapter" href="Cache.html"> <link title="Check" rel="Chapter" href="Check.html"> <link title="Camlp4Utils" rel="Chapter" href="Camlp4Utils.html"> <link title="Configuration" rel="Chapter" href="Configuration.html"> <link title="State" rel="Chapter" href="State.html"> <link title="Plugin" rel="Chapter" href="Plugin.html"> <link title="Aspell" rel="Chapter" href="Aspell.html"> <link title="CheckName" rel="Chapter" href="CheckName.html"> <link title="Parameter" rel="Chapter" href="Parameter.html"> <link title="Version" rel="Chapter" href="Version.html"> <link title="RollingHash" rel="Chapter" href="RollingHash.html"> <link title="Args" rel="Chapter" href="Args.html"> <link title="Predefined" rel="Chapter" href="Predefined.html"> <link title="Html" rel="Chapter" href="Html.html"> <link title="Jdepend" rel="Chapter" href="Jdepend.html"> <link title="Xml" rel="Chapter" href="Xml.html"> <link title="Summary" rel="Chapter" href="Summary.html"> <link title="Checkstyle" rel="Chapter" href="Checkstyle.html"> <link title="Binary" rel="Chapter" href="Binary.html"> <link title="Csv" rel="Chapter" href="Csv.html"> <link title="Text" rel="Chapter" href="Text.html"> <link title="Code_uselessExternalParentheses" rel="Chapter" href="Code_uselessExternalParentheses.html"> <link title="Metrics_halstead" rel="Chapter" href="Metrics_halstead.html"> <link title="Typo_header" rel="Chapter" href="Typo_header.html"> <link title="Typo_spacesAroundBlocks" rel="Chapter" href="Typo_spacesAroundBlocks.html"> <link title="Code_tupleSize" rel="Chapter" href="Code_tupleSize.html"> <link title="Doc_classComment" rel="Chapter" href="Doc_classComment.html"> <link title="Code_uselessBinding" rel="Chapter" href="Code_uselessBinding.html"> <link title="Code_builtinTypes" rel="Chapter" href="Code_builtinTypes.html"> <link title="Code_deprecated" rel="Chapter" href="Code_deprecated.html"> <link title="Code_noEffectAssignment" rel="Chapter" href="Code_noEffectAssignment.html"> <link title="Typo_tabCharacter" rel="Chapter" href="Typo_tabCharacter.html"> <link title="Code_nestedWhile" rel="Chapter" href="Code_nestedWhile.html"> <link title="Interf_exportedEmpty" rel="Chapter" href="Interf_exportedEmpty.html"> <link title="Doc_spell" rel="Chapter" href="Doc_spell.html"> <link title="Code_parameterCount" rel="Chapter" href="Code_parameterCount.html"> <link title="Code_length" rel="Chapter" href="Code_length.html"> <link title="Code_nestedTry" rel="Chapter" href="Code_nestedTry.html"> <link title="Doc_moduleComment" rel="Chapter" href="Doc_moduleComment.html"> <link title="Code_identifierLength" rel="Chapter" href="Code_identifierLength.html"> <link title="Code_negatedIf" rel="Chapter" href="Code_negatedIf.html"> <link title="Interf_duplicate" rel="Chapter" href="Interf_duplicate.html"> <link title="Code_nestedFor" rel="Chapter" href="Code_nestedFor.html"> <link title="Code_nestedIf" rel="Chapter" href="Code_nestedIf.html"> <link title="Code_ignoreUnit" rel="Chapter" href="Code_ignoreUnit.html"> <link title="Doc_classTypeComment" rel="Chapter" href="Doc_classTypeComment.html"> <link title="Code_textualDuplicate" rel="Chapter" href="Code_textualDuplicate.html"> <link title="Typo_spacesAroundOperators" rel="Chapter" href="Typo_spacesAroundOperators.html"> <link title="Code_idempotentOperations" rel="Chapter" href="Code_idempotentOperations.html"> <link title="Code_physicalComparisons" rel="Chapter" href="Code_physicalComparisons.html"> <link title="Typo_lineLength" rel="Chapter" href="Typo_lineLength.html"> <link title="Code_complexCondition" rel="Chapter" href="Code_complexCondition.html"> <link title="Interf_exportedCount" rel="Chapter" href="Interf_exportedCount.html"> <link title="Doc_typeComment" rel="Chapter" href="Doc_typeComment.html"> <link title="Typo_trailingNewLine" rel="Chapter" href="Typo_trailingNewLine.html"> <link title="Typo_fileLength" rel="Chapter" href="Typo_fileLength.html"> <link title="Code_emptyFor" rel="Chapter" href="Code_emptyFor.html"> <link title="Doc_exceptionComment" rel="Chapter" href="Doc_exceptionComment.html"> <link title="Typo_spacesAroundPunctuation" rel="Chapter" href="Typo_spacesAroundPunctuation.html"> <link title="Doc_valueComment" rel="Chapter" href="Doc_valueComment.html"> <link title="Code_stringLiterals" rel="Chapter" href="Code_stringLiterals.html"> <link title="Code_emptyWhile" rel="Chapter" href="Code_emptyWhile.html"> <link title="Code_magicNumber" rel="Chapter" href="Code_magicNumber.html"> <link title="Misc_regexp" rel="Chapter" href="Misc_regexp.html"> <link title="Code_catchAll" rel="Chapter" href="Code_catchAll.html"> <link title="Interf_methodCount" rel="Chapter" href="Interf_methodCount.html"> <link title="Metrics_mccabe" rel="Chapter" href="Metrics_mccabe.html"> <link title="Metrics_coupling" rel="Chapter" href="Metrics_coupling.html"> <link title="Doc_moduleTypeComment" rel="Chapter" href="Doc_moduleTypeComment.html"> <link title="Code_emptyTry" rel="Chapter" href="Code_emptyTry.html"> <link title="Code_predefinedOperators" rel="Chapter" href="Code_predefinedOperators.html"> <link title="Code_predefinedExceptions" rel="Chapter" href="Code_predefinedExceptions.html"> <link title="Code_open" rel="Chapter" href="Code_open.html"> <link title="Typo_trailingWhiteSpace" rel="Chapter" href="Typo_trailingWhiteSpace.html"><title>OutputName</title> </head> <body> <div class="navbar"><a class="pre" href="CategoryName.html" title="CategoryName">Previous</a> <a class="up" href="index.html" title="Index">Up</a> <a class="post" href="OcamldocUtils.html" title="OcamldocUtils">Next</a> </div> <h1>Module <a href="type_OutputName.html">OutputName</a></h1> <pre><span class="keyword">module</span> OutputName: <code class="code">sig</code> <a href="OutputName.html">..</a> <code class="code">end</code></pre><div class="info module top"> Names for outputs.<br> </div> <hr width="100%"> <pre><code><span id="TYPEerror"><span class="keyword">type</span> <code class="type"></code>error</span> = </code></pre><table class="typetable"> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTerror.Empty_name"><span class="constructor">Empty_name</span></span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTerror.Invalid_character"><span class="constructor">Invalid_character</span></span> <span class="keyword">of</span> <code class="type">char</code></code></td> </tr></table> <pre><span id="EXCEPTIONException"><span class="keyword">exception</span> Exception</span> <span class="keyword">of</span> <code class="type"><a href="OutputName.html#TYPEerror">error</a></code></pre> <div class="info "> Exception to be raised when a function of this module fails.<br> </div> <pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = private <code class="type">string</code> </pre> <div class="info "> The type of output names, respecting the "<code class="code">a-z\-</code>+" regular expression.<br> </div> <pre><span id="VALmake"><span class="keyword">val</span> make</span> : <code class="type">string -> <a href="OutputName.html#TYPEt">t</a></code></pre><div class="info "> <code class="code">make x</code> returns the check name equal to <code class="code">x</code>. Raises <code class="code">Exception</code> if <code class="code">x</code> is either empty, or contains a character that is neither a lowercase letter, nor the minus sign.<br> </div> </body></html>