diff options
Diffstat (limited to 'ocamldoc/odoc_sig.mli')
| -rw-r--r-- | ocamldoc/odoc_sig.mli | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/ocamldoc/odoc_sig.mli b/ocamldoc/odoc_sig.mli index f0c3c4a13..5dc4b4c8c 100644 --- a/ocamldoc/odoc_sig.mli +++ b/ocamldoc/odoc_sig.mli @@ -27,10 +27,10 @@ module Signature_search : @raise Not_found if error.*) val search_value : tab -> string -> Types.type_expr - (** This function returns the type expression list for the exception whose name is given, + (** This function returns the Types.extension_constructor for the extension whose name is given, in the given table. @raise Not_found if error.*) - val search_exception : tab -> string -> Types.exception_declaration + val search_extension : tab -> string -> Types.extension_constructor (** This function returns the Types.type_declaration for the type whose name is given, in the given table. @@ -42,7 +42,7 @@ module Signature_search : @raise Not_found if error.*) val search_class : tab -> string -> Types.class_declaration - (** This function returns the Types.cltype_declaration for the class type whose name is given, + (** This function returns the Types.class_type_declaration for the class type whose name is given, in the given table. @raise Not_found if error.*) val search_class_type : tab -> string -> Types.class_type_declaration @@ -139,8 +139,14 @@ module Analyser : [pos_end] is last char of the complete type definition. [pos_limit] is the position of the last char we could use to look for a comment, i.e. usually the beginning on the next element.*) - val name_comment_from_type_kind : - int -> int -> Parsetree.type_kind -> int * (string * Odoc_types.info option) list + val name_comment_from_type_decl : + int -> int -> Parsetree.type_declaration -> int * (string * Odoc_types.info option) list + + (** This function converts a [Types.type_expr] into a [Odoc_type.type_kind], + by associating the comment found in the parstree of each object field, if any. *) + val manifest_structure : + Odoc_env.env -> (string * Odoc_types.info option) list -> + Types.type_expr -> Odoc_type.type_manifest (** This function converts a [Types.type_kind] into a [Odoc_type.type_kind], by associating the comment found in the parsetree of each constructor/field, if any.*) |