summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoroctachron <octa@polychoron.fr>2016-10-02 14:30:03 +0200
committeroctachron <octa@polychoron.fr>2017-10-04 13:05:05 +0200
commit9c8ac99009a1083c71f4705c03e53475f9511e16 (patch)
treee723468020a7e22a79a8ad809aee55ff54253342
parente5715c7bf58246b09ef7a29b75fd9a0f0f7ed76f (diff)
downloadocaml-9c8ac99009a1083c71f4705c03e53475f9511e16.tar.gz
fix few documentation headers
-rw-r--r--ocamldoc/odoc_info.mli16
-rw-r--r--stdlib/bytes.mli2
2 files changed, 9 insertions, 9 deletions
diff --git a/ocamldoc/odoc_info.mli b/ocamldoc/odoc_info.mli
index 2a2d80ea1c..d0d183b40a 100644
--- a/ocamldoc/odoc_info.mli
+++ b/ocamldoc/odoc_info.mli
@@ -135,7 +135,7 @@ module Name :
(** Representation and manipulation of method / function / class / module parameters.*)
module Parameter :
sig
- (** {2 Types} *)
+ (** {1 Types} *)
(** Representation of a simple parameter name *)
type simple_name = Odoc_parameter.simple_name =
@@ -154,7 +154,7 @@ module Parameter :
(** A parameter is just a param_info.*)
type parameter = param_info
- (** {2 Functions} *)
+ (** {1 Functions} *)
(** Access to the name as a string. For tuples, parentheses and commas are added. *)
val complete_name : parameter -> string
@@ -343,7 +343,7 @@ module Value :
(** Representation and manipulation of classes and class types.*)
module Class :
sig
- (** {2 Types} *)
+ (** {1 Types} *)
(** To keep the order of elements in a class. *)
type class_element = Odoc_class.class_element =
@@ -429,7 +429,7 @@ module Class :
mutable clt_loc : location ;
}
- (** {2 Functions} *)
+ (** {1 Functions} *)
(** Access to the elements of a class. *)
val class_elements : ?trans:bool -> t_class -> class_element list
@@ -465,7 +465,7 @@ module Class :
(** Representation and manipulation of modules and module types. *)
module Module :
sig
- (** {2 Types} *)
+ (** {1 Types} *)
(** To keep the order of elements in a module. *)
type module_element = Odoc_module.module_element =
@@ -570,7 +570,7 @@ module Module :
mutable mt_loc : location ;
}
- (** {2 Functions for modules} *)
+ (** {1 Functions for modules} *)
(** Access to the elements of a module. *)
val module_elements : ?trans:bool -> t_module -> module_element list
@@ -620,7 +620,7 @@ module Module :
(** The list of module comments. *)
val module_comments : ?trans:bool-> t_module -> text list
- (** {2 Functions for module types} *)
+ (** {1 Functions for module types} *)
(** Access to the elements of a module type. *)
val module_type_elements : ?trans:bool-> t_module_type -> module_element list
@@ -749,7 +749,7 @@ val string_of_attribute : Value.t_attribute -> string
(** @return a string to describe the given method. *)
val string_of_method : Value.t_method -> string
-(** {2 Miscelaneous functions} *)
+(** {2 Miscellaneous functions} *)
(** Return the first sentence (until the first dot followed by a blank
or the first blank line) of a text.
diff --git a/stdlib/bytes.mli b/stdlib/bytes.mli
index 8c6b585f9a..3bef5b4abb 100644
--- a/stdlib/bytes.mli
+++ b/stdlib/bytes.mli
@@ -261,7 +261,7 @@ val rcontains_from : bytes -> int -> char -> bool
val uppercase : bytes -> bytes
[@@ocaml.deprecated "Use Bytes.uppercase_ascii instead."]
-(* Return a copy of the argument, with all lowercase letters
+(** Return a copy of the argument, with all lowercase letters
translated to uppercase, including accented letters of the ISO
Latin-1 (8859-1) character set.
@deprecated Functions operating on Latin-1 character set are deprecated. *)