Title: Theory / Unimportant / CS / Programming / oCaml / Manual{ / 16 documentation
Tags: comment computer_to_instruction fromCommandLine récupéré

Instruction: ocamldoc foo
Page: https://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html
Effect: Generate documentation from the ocaml code foo
Language: ocaml
Chapter: 16
Section: 1

Question: Which documentations are generated
Answer: The ones of elements present in mli, only, assuming it exists
Page: https://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html
Chapter: 16
Section: 1.2
Answer2: The documentation from mli if it exists
Answer3: The documentation from .ml if there is -m or if there is no documentation in mli

Question: Restriction for correct documentation
Answer: In a module, no two classes/classes type of the same name
Page: https://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html
Chapter: 16
Section: 1.3
Answer2: In a module, no two module/module type of the same name
Answer3: No two values/types/exceptions with the same name
Answer4: no documentation of tuple

Language: oCaml
Documentation: (** foo *) (not more than two * )
Other fields (not shown on cards):
Chapter: 16
Comment: (* foo *)
Page: https://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html
Section: 1.3