diff6-10.chapter15.txtこのページは最後に更新されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。 last mod. 2008-08-28 (木) 09:54:41
30a31
>
41c42
< -css-style.
---
> -css-style. The file style.css is not generated if it already exists.
45,47c46,48
< option. The document uses the style file ocamldoc.sty included in the
< OCamldoc distribution. You can change this file to customize the style of
< your LaTeX documentation.
---
> option. The document uses the style file ocamldoc.sty. This file is
> generated when using the -latex option, if it does not already exist. You
> can change this file to customize the style of your LaTeX documentation.
65c66,75
< ocamldoc command, but not by its native-code version ocamldoc.opt.
---
> ocamldoc command, but not by its native-code version ocamldoc.opt. If the
> given file is a simple one and does not exist in the current directory, then
> ocamldoc looks for it in the custom generators default directory, and in the
> directories specified with optional -i options.
>
> -customdir Display the custom generators default directory.
>
> -i directory Add the given directory to the path where to look for custom
> generators.
>
72a83
>
83,85c94,96
< elements in implementation files are kept, and the -m option indicates
< which parts of the comments in interface files are merged with the comments
< in implementation files.
---
> elements in implementation files are kept, and the -m option indicates which
> parts of the comments in interface files are merged with the comments in
> implementation files.
88,90c99,101
< variables, when available. The source code is always kept when a .ml file
< is given, but is by default discarded when a .mli is given. This option
< allows to always keep the source code.
---
> variables, when available. The source code is always kept when a .ml file is
> given, but is by default discarded when a .mli is given. This option allows
> to always keep the source code.
113,114c124,125
< -no-stop Keep elements placed after the (**/**) special comment (see section
< 15.2).
---
> -no-stop Keep elements placed after/between the (**/**) special comment(s)
> (see section 15.2).
124,125c135,136
< -stars Remove blank characters until the first asterisk ('*') in each line
< of comments.
---
> -stars Remove blank characters until the first asterisk ('*') in each line of
> comments.
128a140,143
> -intro file Use content of file as ocamldoc text to use as introduction
> (HTML, LaTeXand TeXinfo only). For HTML, the file is used to create the
> whole index.html file.
>
132a148,150
> -hide-warnings Do not print OCamldoc warnings.
>
>
141a160
>
150a170
>
167a188,192
> -short-functors Use a short form to display functors: module M : functor
> (A:Module) -> functor (B:Module2) -> sig .. end is displayed as module M
> (A:Module) (B:Module2) : sig .. end.
>
>
192c217
< -notoc Do not generate a table of contents (LaTeX only).
---
> -notoc Do not generate a table of contents.
199a225
>
207a234,239
> -info-entry Specify Info directory entry.
>
> -info-section Specify section of Info directory.
>
> -noheader Suppress header in generated documentation.
>
209a242,244
> -notrailer Suppress trailer in generated documentation.
>
>
235a271
>
253,256c289,292
< Information on a module can be extracted either from the .mli or .ml file,
< or both, depending on the files given on the command line. When both .mli and
< .ml files are given for the same module, information extracted from these
< files is merged according to the following rules:
---
> Information on a module can be extracted either from the .mli or .ml file, or
> both, depending on the files given on the command line. When both .mli and .ml
> files are given for the same module, information extracted from these files is
> merged according to the following rules:
276,281c312,318
< - In a module, there must not be two modules, two module types or a module
< and a module type with the same name.
< - In a module, there must not be two classes, two class types or a class and
< a class type with the same name.
< - In a module, there must not be two values, two types, or two exceptions
< with the same name.
---
> - In a module, there must not be two modules, two module types or a module and
> a module type with the same name. In the default HTML generator, modules ab
> and AB will be printed to the same file on case insensitive file systems.
> - In a module, there must not be two classes, two class types or a class and a
> class type with the same name.
> - In a module, there must not be two values, two types, or two exceptions with
> the same name.
285,286c322
< <<
< open Foo (* which has a module Bar with a value x *)
---
> <<open Foo (* which has a module Bar with a value x *)
334c370,372
< field definition, without blank lines or other comments between them.
---
> field definition, without blank lines or other comments between them. The
> special comment for a type constructor with another type constructor following
> must be placed before the '|' character separating the two constructors.
337,338c375
< <<
< (** The first special comment of the file is the comment associated
---
> <<(** The first special comment of the file is the comment associated
457c494,496
< or field definition, without blank line between them.
---
> or field definition, without blank line between them. The special comment for a
> type constructor with another type constructor following must be placed before
> the '|' character separating the two constructors.
460,461c499
< <<
< (** The first special comment of the file is the comment associated
---
> <<(** The first special comment of the file is the comment associated
535,537c573,574
< type. For instance:
< <<
< class type foo =
---
> type, or up to the next stop comment. For instance:
> <<class type foo =
554a592
> (**/**)
556c594,596
< (** The type t does not appear either. *)
---
> (** The type t appears since in the documentation since the previous stop
> comment
> toggled off the "no documentation mode". *)
572,573c612
< <<
< (** The comment begins with a description, which is text formatted
---
> <<(** The comment begins with a description, which is text formatted
599,602c638,641
< | {[0-9]+:label text} same, but also associate the
< name label to the current
< point. This point can be
< referenced by its
---
> | {[0-9]+:label text} same, but also associate
> the name label to the
> current point. This point
> can be referenced by its
620,621c659,660
< preformatted source
< code style.
---
> preformatted source code
> style.
624,625c663,664
< | {% string %} take the given string as
< raw LaTeX code.
---
> | {% string %} take the given string as raw
> LaTeX code.
630c669,686
< Foo.Bar.t.
---
> 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: {!kind:
> Foo.Bar.t} where kind can be
> module, modtype, class,
> classtype, val, type,
> exception, attribute, method
> or section.
> | {!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 (types,
> values, modules, ...). Used
> in HTML only.
634,636c690,692
< is; special characters
< ('{', '}', '[', ']' and '@')
< must be escaped by a '\'
---
> is; special characters ('{',
> '}', '[', ']' and '@') must
> be escaped by a '\'
643,644c699
< <<
< (** Here is a {b list}
---
> <<(** Here is a {b list}
652,653c707
< <<
< (** Here is a {b list}
---
> <<(** Here is a {b list}
662,663c716,717
< In the description of a value, type, exception, module, module type, class
< or class type, the first sentence is sometimes used in indexes, or when just a
---
> In the description of a value, type, exception, module, module type, class or
> class type, the first sentence is sometimes used in indexes, or when just a
681a736
>
688c743
< |@deprecated |The text should describe |
---
> | @deprecated |The text should describe |
694,695c749,750
< |@param id text|Associate the given |
< | |description (text) to the |
---
> | @param id |Associate the given |
> |text |description (text) to the |
701c756
< |@raise Exc |Explain that the element may|
---
> | @raise Exc |Explain that the element may|
704c759
< |@return text |Describe the return value |
---
> | @return text |Describe the return value |
709,711c764,766
< |@see <url> |Add a reference to the URL |
< |text |between '<' and '>' with |
< | |the given text as comment. |
---
> | @see <url> |Add a reference to the URL |
> |text |between '<' and '>' with the|
> | |given text as comment. |
713c768
< |@see |Add a reference to the given|
---
> | @see |Add a reference to the given|
718,720c773,775
< |@see "document|Add a reference to the given|
< |name" text |document name (written |
< | |between double quotes), with|
---
> | @see |Add a reference to the given|
> |"document |document name (written |
> |name" text |between double quotes), with|
723c778
< |@since string |Indicates when the element |
---
> | @since string|Indicates when the element |
726c781
< |@version |The version number for the |
---
> | @version |The version number for the |
737,738c792
< <<
< (** My comment to show you a custom tag.
---
> <<(** My comment to show you a custom tag.
743,744c797,798
< To handle custom tags, you need to define a custom generator, as explained
< in section 15.3.2.
---
> To handle custom tags, you need to define a custom generator, as explained in
> section 15.3.2.
779,780c833
< <<
< class my_doc_gen =
---
> <<class my_doc_gen =
804a858
>
813,814c867
< <<
< class my_gen =
---
> <<class my_gen =
860c913
< ocamldoc -g custom.cmo other_options source_files
---
> ocamldoc -g custom.cmo other-options source-files
879c932
< ocamldoc -g custom.cma other_options source_files
---
> ocamldoc -g custom.cma other-options source-files
884d936
<
|