Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- diff --git a/manual/cmds/ocamldoc.etex b/manual/cmds/ocamldoc.etex
- index 36819b0..563c6df 100644
- --- a/manual/cmds/ocamldoc.etex
- +++ b/manual/cmds/ocamldoc.etex
- @@ -754,13 +754,8 @@ text: {{text-element}}
- source code style.\\
- @||@&@ '{v' string 'v}' @ & set the given @string@ in verbatim style. \\
- @||@&@ '{%' string '%}' @ & take the given @string@ as raw \LaTeX\ code.\\
- -@||@&@ '{!' string '}' @ & insert a reference to the element named
- -@string@. @string@ must be a fully qualified element name,
- -for example "Foo.Bar.t". The kind of the referenced element can be forced
- -(useful when various elements have the same qualified name) with the following
- -syntax: @ '{!' @ \nt{kind} @ ':' string '}' @ where \nt{kind} can be
- -"module", "modtype", "class", "classtype", "val",
- -"type", "exception", "attribute", "method" or "section".\\
- +@||@&@ '{!' string '}' @ & insert a cross-reference to an element
- + (see below \ref{sss:crossref} for the syntax of cross-references).\\
- @||@&@ '{!modules:' string string ... '}' @ & insert an index table
- for the given module names. Used in HTML only.\\
- @||@&@ '{!indexlist}' @ & insert a table of links to the various indexes
- @@ -773,6 +768,8 @@ must be escaped by a '"\\"'\\
- @||@& \nt{blank-line} & force a new line.
- \end{tabular} \\
- +\subsubsection*{List formatting}
- +
- \begin{syntax}
- list:
- | {{ '{-' text '}' }}
- @@ -801,6 +798,40 @@ The same shortcut is available for enumerated lists, using '"+"'
- instead of '"-"'.
- Note that only one list can be defined by this shortcut in nested lists.
- +\subsubsection*{Cross-reference formatting}
- +\label{sss:crossref}
- +
- +Cross-references are fully qualified element names, as in the example
- +"{!Foo.Bar.t}". This is an ambiguous reference as it may designate
- +a type name, a value name, a class name, etc. It is possible to make
- +explicit the intended syntactic class, using "{!type:Foo.Bar.t}" to
- +designate a type, and "{!val:Foo.Bar.t}" a value of the same name.
- +
- +The list of possible syntactic class is as follows:
- +\begin{itemize}
- + \item["module:"] module
- + \item["modtype:"] module type
- + \item["class:"] class
- + \item["classtype:"] class type
- + \item["val:"] value
- + \item["type:"] type
- + \item["exception:"] exception
- + \item["attribute:"] attribute
- + \item["method:"] class method
- + \item["section:"] ocamldoc section
- + \item["const:"] variant constructor
- + \item["recfield:"] record field
- +\end{itemize}
- +
- +In the case of variant constructors or record field, the constructor
- +or field name should be preceded by the name of the correspond type --
- +to avoid the ambiguity of several types having the same constructor
- +names. For example, the constructor "Node" of the type "tree" will be
- +referenced as "{!tree.Node}" or "{!const:tree.Node}", or possibly
- +"{!Mod1.Mod2.tree.Node}" from outside the module.
- +
- +\subsubsection*{First sentence}
- +
- In the description of a value, type, exception, module, module type, class
- or class type, the {\em first sentence} is sometimes used in indexes, or
- when just a part of the description is needed. The first sentence
Add Comment
Please, Sign In to add comment