diff --git a/src/core/CCArray.mli b/src/core/CCArray.mli index e5b12d33..d2c767f1 100644 --- a/src/core/CCArray.mli +++ b/src/core/CCArray.mli @@ -1,7 +1,6 @@ - (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Array utils} *) +(** Array utils *) type 'a iter = ('a -> unit) -> unit (** Fast internal iterator. @@ -18,7 +17,7 @@ type 'a printer = Format.formatter -> 'a -> unit include module type of CCShimsArray_ val empty : 'a t -(** [empty] is the empty array, physically equal to [||]. *) +(** [empty] is the empty array, physically equal to [[||]]. *) val equal : 'a equal -> 'a t equal (** [equal eq a1 a2] is [true] if the lengths of [a1] and [a2] are the same diff --git a/src/core/CCArrayLabels.mli b/src/core/CCArrayLabels.mli index f3f32178..2b53dbb4 100644 --- a/src/core/CCArrayLabels.mli +++ b/src/core/CCArrayLabels.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Array utils} *) +(** Array utils (Labeled version of {!CCArray}) *) type 'a iter = ('a -> unit) -> unit (** Fast internal iterator. diff --git a/src/core/CCBool.mli b/src/core/CCBool.mli index 1208d76d..9fda5922 100644 --- a/src/core/CCBool.mli +++ b/src/core/CCBool.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Basic Bool functions} *) +(** Basic Bool functions *) type t = bool diff --git a/src/core/CCCanonical_sexp.mli b/src/core/CCCanonical_sexp.mli index d3320c0a..e53ce494 100644 --- a/src/core/CCCanonical_sexp.mli +++ b/src/core/CCCanonical_sexp.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Canonical S-expressions} +(** Canonical S-expressions See {{: https://en.wikipedia.org/wiki/Canonical_S-expressions} wikipedia}. These S-expressions are binary safe. diff --git a/src/core/CCChar.mli b/src/core/CCChar.mli index 2103b06f..bfffd045 100644 --- a/src/core/CCChar.mli +++ b/src/core/CCChar.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Utils around char} +(** Utils around char @since 0.14 *) diff --git a/src/core/CCEither.mli b/src/core/CCEither.mli index bde3dc8d..3b7bb3d9 100644 --- a/src/core/CCEither.mli +++ b/src/core/CCEither.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Either Monad} +(** Either Monad Module that is compatible with Either form OCaml 4.12 but can be use with any ocaml version compatible with container diff --git a/src/core/CCEqual.mli b/src/core/CCEqual.mli index c1f07366..72eaf137 100644 --- a/src/core/CCEqual.mli +++ b/src/core/CCEqual.mli @@ -3,7 +3,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Equality Combinators} *) +(** Equality Combinators *) (** @since 1.2 *) diff --git a/src/core/CCEqualLabels.mli b/src/core/CCEqualLabels.mli index 61ce6a69..764abe2d 100644 --- a/src/core/CCEqualLabels.mli +++ b/src/core/CCEqualLabels.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Equality Combinators} *) +(** Equality Combinators (Labeled version of {!CCEqual}) *) (** @since 1.2 *) diff --git a/src/core/CCFloat.mli b/src/core/CCFloat.mli index 0e7157dd..715f7afd 100644 --- a/src/core/CCFloat.mli +++ b/src/core/CCFloat.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Basic operations on floating-point numbers} +(** Basic operations on floating-point numbers @since 0.6.1 *) open CCShims_ diff --git a/src/core/CCFormat.mli b/src/core/CCFormat.mli index aedbcbfa..dcb74c6a 100644 --- a/src/core/CCFormat.mli +++ b/src/core/CCFormat.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Helpers for Format} +(** Helpers for Format @since 0.8 *) diff --git a/src/core/CCFun.mli b/src/core/CCFun.mli index 83ba6f8f..45fb8d39 100644 --- a/src/core/CCFun.mli +++ b/src/core/CCFun.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Basic Functions} *) +(** Basic operations on Functions *) include module type of CCShimsFun_ diff --git a/src/core/CCHash.mli b/src/core/CCHash.mli index 884f11a8..c297c3ed 100644 --- a/src/core/CCHash.mli +++ b/src/core/CCHash.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Hash combinators} +(** Hash combinators The API of this module is stable as per semantic versioning, like the rest of containers. However the exact implementation of hashing function diff --git a/src/core/CCHashtbl.mli b/src/core/CCHashtbl.mli index 7a26b790..f7e131d0 100644 --- a/src/core/CCHashtbl.mli +++ b/src/core/CCHashtbl.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Extension to the standard Hashtbl} +(** Extension to the standard Hashtbl @since 0.4 *) diff --git a/src/core/CCHeap.mli b/src/core/CCHeap.mli index 6aed8a0e..00084a07 100644 --- a/src/core/CCHeap.mli +++ b/src/core/CCHeap.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Leftist Heaps} +(** Leftist Heaps Implementation following Okasaki's book. *) diff --git a/src/core/CCIO.mli b/src/core/CCIO.mli index dfeffd13..ff03520a 100644 --- a/src/core/CCIO.mli +++ b/src/core/CCIO.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 IO Utils} +(** 1 IO Utils Simple utilities to deal with basic Input/Output tasks in a resource-safe way. For advanced IO tasks, the user is advised to use something diff --git a/src/core/CCInt.mli b/src/core/CCInt.mli index 3e299584..57d6aaa0 100644 --- a/src/core/CCInt.mli +++ b/src/core/CCInt.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Basic Int functions} *) +(** Basic Int functions *) include module type of CCShimsInt_ diff --git a/src/core/CCInt32.mli b/src/core/CCInt32.mli index 3dd383cb..2f15dce2 100644 --- a/src/core/CCInt32.mli +++ b/src/core/CCInt32.mli @@ -1,8 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Int32} - - Helpers for 32-bit integers. +(** Helpers for 32-bit integers. This module provides operations on the type int32 of signed 32-bit integers. Unlike the built-in int type, the type int32 is guaranteed to be exactly diff --git a/src/core/CCInt64.mli b/src/core/CCInt64.mli index 3a55f996..d8a08818 100644 --- a/src/core/CCInt64.mli +++ b/src/core/CCInt64.mli @@ -1,8 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Int64} - - Helpers for 64-bit integers. +(** Helpers for 64-bit integers. This module provides operations on the type int64 of signed 64-bit integers. Unlike the built-in int type, the type int64 is guaranteed to be exactly diff --git a/src/core/CCList.mli b/src/core/CCList.mli index 489298e7..9a3e13b8 100644 --- a/src/core/CCList.mli +++ b/src/core/CCList.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Complements to list} *) +(** Complements to List *) type 'a iter = ('a -> unit) -> unit (** Fast internal iterator. diff --git a/src/core/CCListLabels.mli b/src/core/CCListLabels.mli index 3ba7215d..f2b93b0c 100644 --- a/src/core/CCListLabels.mli +++ b/src/core/CCListLabels.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Complements to list} *) +(** Complements to ListLabels *) type 'a iter = ('a -> unit) -> unit (** Fast internal iterator. diff --git a/src/core/CCMap.mli b/src/core/CCMap.mli index 76bfa18e..b5dc11cc 100644 --- a/src/core/CCMap.mli +++ b/src/core/CCMap.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Extensions of Standard Map} +(** Extensions of Standard Map Provide useful functions and iterators on [Map.S] @since 0.5 *) diff --git a/src/core/CCNativeint.mli b/src/core/CCNativeint.mli index ef0938c1..caef51c7 100644 --- a/src/core/CCNativeint.mli +++ b/src/core/CCNativeint.mli @@ -1,8 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Nativeint} - - Helpers for processor-native integers +(** Helpers for processor-native integers This module provides operations on the type [nativeint] of signed 32-bit integers (on 32-bit platforms) or signed 64-bit integers (on 64-bit platforms). diff --git a/src/core/CCOpt.mli b/src/core/CCOpt.mli index b690e000..defa7570 100644 --- a/src/core/CCOpt.mli +++ b/src/core/CCOpt.mli @@ -1,4 +1,4 @@ -(** Option module +(** Previous Option module @deprecated use `CCOption` instead. *) [@@@ocaml.deprecated "use CCOption instead"] diff --git a/src/core/CCOption.mli b/src/core/CCOption.mli index 8ae50118..72eeb7fa 100644 --- a/src/core/CCOption.mli +++ b/src/core/CCOption.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** Options +(** Basic operations on the option type. This module replaces `CCOpt`. @since 3.6 *) diff --git a/src/core/CCOrd.mli b/src/core/CCOrd.mli index c4e2fed7..165dd725 100644 --- a/src/core/CCOrd.mli +++ b/src/core/CCOrd.mli @@ -1,7 +1,8 @@ +(** Order combinators *) (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Comparisons} *) +(** {2 Comparisons} *) type 'a t = 'a -> 'a -> int (** Comparison (total ordering) between two elements, that returns an int. *) diff --git a/src/core/CCPair.mli b/src/core/CCPair.mli index 2f23a432..31d6ea4f 100644 --- a/src/core/CCPair.mli +++ b/src/core/CCPair.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Tuple Functions} *) +(** Tuple Functions *) type ('a,'b) t = ('a * 'b) diff --git a/src/core/CCParse.mli b/src/core/CCParse.mli index 25c6a6ae..0e0a44e6 100644 --- a/src/core/CCParse.mli +++ b/src/core/CCParse.mli @@ -1,7 +1,7 @@ (* This file is free software. See file "license" for more details. *) -(** {1 Very Simple Parser Combinators} +(** Very Simple Parser Combinators These combinators can be used to write very simple parsers, for example to extract data from a line-oriented file, or as a replacement to {!Scanf}. diff --git a/src/core/CCRandom.mli b/src/core/CCRandom.mli index 47b41226..920ce5fe 100644 --- a/src/core/CCRandom.mli +++ b/src/core/CCRandom.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Random Generators} *) +(** Random Generators *) include module type of struct include Random end (** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Random.html} Documentation for the standard Random module}*) diff --git a/src/core/CCRef.mli b/src/core/CCRef.mli index 672bba80..7b66ad0b 100644 --- a/src/core/CCRef.mli +++ b/src/core/CCRef.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 References} +(** Helpers for references @since 0.9 *) type 'a printer = Format.formatter -> 'a -> unit diff --git a/src/core/CCResult.mli b/src/core/CCResult.mli index f9033443..3ba440df 100644 --- a/src/core/CCResult.mli +++ b/src/core/CCResult.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Error Monad} +(** Error Monad Uses the new "result" type from OCaml 4.03. diff --git a/src/core/CCSeq.mli b/src/core/CCSeq.mli index 77ae4ff0..6d93b147 100644 --- a/src/core/CCSeq.mli +++ b/src/core/CCSeq.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Helpers for the standard {b Seq} type} +(** Helpers for the standard {b Seq} type See {{: https://github.com/c-cube/oseq/} oseq} for a richer API. *) diff --git a/src/core/CCSet.mli b/src/core/CCSet.mli index f39abac5..bb3edefb 100644 --- a/src/core/CCSet.mli +++ b/src/core/CCSet.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Wrapper around Set} +(** Wrapper around Set @since 0.9 *) diff --git a/src/core/CCSexp.mli b/src/core/CCSexp.mli index 53c33dac..1a7b5505 100644 --- a/src/core/CCSexp.mli +++ b/src/core/CCSexp.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Handling S-expressions} +(** Handling S-expressions @since 3.0 moved into containers-core, previously in [containers.sexp] *) diff --git a/src/core/CCString.mli b/src/core/CCString.mli index 0771bd9f..f0e77b80 100644 --- a/src/core/CCString.mli +++ b/src/core/CCString.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Basic String Utils} *) +(** Basic String Utils *) type 'a iter = ('a -> unit) -> unit (** Fast internal iterator. diff --git a/src/core/CCStringLabels.mli b/src/core/CCStringLabels.mli index bc8acf54..e3bf170e 100644 --- a/src/core/CCStringLabels.mli +++ b/src/core/CCStringLabels.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Basic String Utils} *) +(** Basic String Utils (Labeled version of {!CCString}) *) type 'a iter = ('a -> unit) -> unit (** Fast internal iterator. diff --git a/src/core/CCUtf8_string.mli b/src/core/CCUtf8_string.mli index 068cef7e..a845330b 100644 --- a/src/core/CCUtf8_string.mli +++ b/src/core/CCUtf8_string.mli @@ -1,5 +1,5 @@ -(** {1 Unicode String, in UTF8} *) +(** Unicode String, in UTF8 *) (** A unicode string represented by a utf8 bytestring. This representation is convenient for manipulating normal OCaml strings that are encoded diff --git a/src/core/CCVector.mli b/src/core/CCVector.mli index 8e02ea64..578cc6db 100644 --- a/src/core/CCVector.mli +++ b/src/core/CCVector.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Growable, mutable vector} *) +(** Growable, mutable vector *) type ro = [`RO] type rw = [`RW] diff --git a/src/core/containers.ml b/src/core/containers.ml index e7d181de..9c367731 100644 --- a/src/core/containers.ml +++ b/src/core/containers.ml @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Drop-In replacement to Stdlib} *) +(** Drop-In replacement to Stdlib *) module Array = CCArray module Bool = CCBool diff --git a/src/core/containersLabels.ml b/src/core/containersLabels.ml index 83342152..29b1e21a 100644 --- a/src/core/containersLabels.ml +++ b/src/core/containersLabels.ml @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Drop-In replacement to Stdlib} *) +(** Drop-In replacement to Stdlib *) module Array = CCArrayLabels module Bool = CCBool diff --git a/src/data/CCBV.mli b/src/data/CCBV.mli index 05277528..7c5942ad 100644 --- a/src/data/CCBV.mli +++ b/src/data/CCBV.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {2 Imperative Bitvectors} +(** Imperative Bitvectors {b BREAKING CHANGES} since 1.2: size is now stored along with the bitvector. Some functions have diff --git a/src/data/CCBijection.mli b/src/data/CCBijection.mli index 45372bf2..65524510 100644 --- a/src/data/CCBijection.mli +++ b/src/data/CCBijection.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Bijection} +(** Functor to build a bijection Represents 1-to-1 mappings between two types. Each element from the "left" is mapped to one "right" value, and conversely. diff --git a/src/data/CCBitField.mli b/src/data/CCBitField.mli index 43680ad9..d5657f4f 100644 --- a/src/data/CCBitField.mli +++ b/src/data/CCBitField.mli @@ -1,9 +1,9 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Bit Field} +(** Efficient Bit Field for up to 31 or 61 fiels This module defines efficient bitfields - up to 30 or 62 bits (depending on the architecture) in + up to 31 or 61 bits (depending on the architecture) in a relatively type-safe way. {[ diff --git a/src/data/CCCache.mli b/src/data/CCCache.mli index e4caee2d..fd14c8eb 100644 --- a/src/data/CCCache.mli +++ b/src/data/CCCache.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Caches} +(** Caches Utils Particularly useful for memoization. See {!with_cache} and {!with_cache_rec} for more details. diff --git a/src/data/CCDeque.mli b/src/data/CCDeque.mli index 48a8adeb..b18ff955 100644 --- a/src/data/CCDeque.mli +++ b/src/data/CCDeque.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Imperative deque} +(** Imperative deque This structure provides fast access to its front and back elements, with O(1) operations. *) diff --git a/src/data/CCFQueue.mli b/src/data/CCFQueue.mli index 5d694de3..7ea80bea 100644 --- a/src/data/CCFQueue.mli +++ b/src/data/CCFQueue.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Functional queues} *) +(** Functional queues *) type 'a iter = ('a -> unit) -> unit type 'a equal = 'a -> 'a -> bool diff --git a/src/data/CCFun_vec.mli b/src/data/CCFun_vec.mli index fd075417..8e7f1b9f 100644 --- a/src/data/CCFun_vec.mli +++ b/src/data/CCFun_vec.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Functional Vectors} *) +(** Functional Vectors *) (** Tree with a large branching factor for logarithmic operations with a low multiplicative factor. diff --git a/src/data/CCGraph.mli b/src/data/CCGraph.mli index 539fad9f..61e0eefb 100644 --- a/src/data/CCGraph.mli +++ b/src/data/CCGraph.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Simple Graph Interface} +(** Simple Graph Interface A collections of algorithms on (mostly read-only) graph structures. The user provides her own graph structure as a [('v, 'e) CCGraph.t], diff --git a/src/data/CCHashSet.mli b/src/data/CCHashSet.mli index 6bf97dcf..cf26af7f 100644 --- a/src/data/CCHashSet.mli +++ b/src/data/CCHashSet.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Mutable Set} +(** Mutable Set {b status: unstable} diff --git a/src/data/CCHashTrie.mli b/src/data/CCHashTrie.mli index 5efe620e..ea0b7a71 100644 --- a/src/data/CCHashTrie.mli +++ b/src/data/CCHashTrie.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Hash Tries} +(** Hash Tries Trie indexed by the hash of the keys, where the branching factor is fixed. The goal is to have a quite efficient functional structure with fast diff --git a/src/data/CCHet.mli b/src/data/CCHet.mli index c578c00c..82f88ed7 100644 --- a/src/data/CCHet.mli +++ b/src/data/CCHet.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Associative containers with Heterogeneous Values} +(** Associative containers with Heterogeneous Values This is similar to {!CCMixtbl}, but the injection is directly used as a key. diff --git a/src/data/CCImmutArray.mli b/src/data/CCImmutArray.mli index ae97d01e..cf7ef059 100644 --- a/src/data/CCImmutArray.mli +++ b/src/data/CCImmutArray.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Immutable Arrays} +(** Immutable Arrays Purely functional use of arrays. Update is costly, but reads are very fast. Sadly, it is not possible to make this type covariant without using black diff --git a/src/data/CCIntMap.mli b/src/data/CCIntMap.mli index 78c2bbc0..7dfb9c5b 100644 --- a/src/data/CCIntMap.mli +++ b/src/data/CCIntMap.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Map specialized for Int keys} +(** Map specialized for Int keys {b status: stable} @since 0.10 *) diff --git a/src/data/CCKTree.mli b/src/data/CCKTree.mli index 0e517dcd..a1c66d3c 100644 --- a/src/data/CCKTree.mli +++ b/src/data/CCKTree.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Lazy Tree Structure} +(** Lazy Tree Structure This structure can be used to represent trees and directed graphs (as infinite trees) in a lazy fashion. Like {!CCKList}, it is a structural type. *) diff --git a/src/data/CCLazy_list.mli b/src/data/CCLazy_list.mli index 52ebe477..f515b6c9 100644 --- a/src/data/CCLazy_list.mli +++ b/src/data/CCLazy_list.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Lazy List} +(** Lazy List @since 0.17 *) diff --git a/src/data/CCMixmap.mli b/src/data/CCMixmap.mli index b854b27e..bbad7633 100644 --- a/src/data/CCMixmap.mli +++ b/src/data/CCMixmap.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Maps with Heterogeneous Values} +(** Maps with Heterogeneous Values {b status: experimental} diff --git a/src/data/CCMixset.mli b/src/data/CCMixset.mli index 620b6abb..142d7d15 100644 --- a/src/data/CCMixset.mli +++ b/src/data/CCMixset.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Set of Heterogeneous Values} +(** Set of Heterogeneous Values {[ let k1 : int key = newkey () in diff --git a/src/data/CCMixtbl.mli b/src/data/CCMixtbl.mli index cf67d85d..78a1ea13 100644 --- a/src/data/CCMixtbl.mli +++ b/src/data/CCMixtbl.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Hash Table with Heterogeneous Keys} +(** Hash Table with Heterogeneous Keys From https://github.com/mjambon/mixtbl (thanks to him). Example: diff --git a/src/data/CCMultiMap.mli b/src/data/CCMultiMap.mli index 007bd41b..19762c71 100644 --- a/src/data/CCMultiMap.mli +++ b/src/data/CCMultiMap.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Multimap} *) +(** Map that can map key to several values *) type 'a iter = ('a -> unit) -> unit diff --git a/src/data/CCMultiSet.mli b/src/data/CCMultiSet.mli index fd2f3146..91f89094 100644 --- a/src/data/CCMultiSet.mli +++ b/src/data/CCMultiSet.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Multiset} *) +(** Multiset *) type 'a iter = ('a -> unit) -> unit diff --git a/src/data/CCMutHeap.mli b/src/data/CCMutHeap.mli index 79abe3a4..982c332a 100644 --- a/src/data/CCMutHeap.mli +++ b/src/data/CCMutHeap.mli @@ -2,7 +2,7 @@ As such it is under the Apache 2 License. *) -(** {1 Mutable Heaps} +(** Mutable Heaps The classic binary heap in a vector. diff --git a/src/data/CCPersistentArray.mli b/src/data/CCPersistentArray.mli index 786f85d8..9fc760a9 100644 --- a/src/data/CCPersistentArray.mli +++ b/src/data/CCPersistentArray.mli @@ -24,7 +24,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *) -(** {1 Persistent Arrays} +(** Persistent Arrays From the paper by Jean-Christophe Filliâtre, "A persistent Union-Find data structure", see diff --git a/src/data/CCPersistentHashtbl.mli b/src/data/CCPersistentHashtbl.mli index efe5a619..b0f07ccc 100644 --- a/src/data/CCPersistentHashtbl.mli +++ b/src/data/CCPersistentHashtbl.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Persistent hash-table on top of OCaml's hashtables} +(** Persistent hash-table on top of OCaml's hashtables Almost as efficient as the regular Hashtbl type, but with a persistent interface (rewinding changes to get back in the past history). This is diff --git a/src/data/CCRAL.mli b/src/data/CCRAL.mli index 2a9d2d16..be737a67 100644 --- a/src/data/CCRAL.mli +++ b/src/data/CCRAL.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Random-Access Lists} +(** Random-Access Lists This is an OCaml implementation of Okasaki's paper "Purely Functional Random Access Lists". It defines a list-like data diff --git a/src/data/CCRingBuffer.mli b/src/data/CCRingBuffer.mli index 66a56852..9700a0ce 100644 --- a/src/data/CCRingBuffer.mli +++ b/src/data/CCRingBuffer.mli @@ -3,7 +3,7 @@ (* Copyright (C) 2015 Simon Cruanes, Carmelo Piccione *) -(** {1 Circular Buffer (Deque)} +(** Circular Buffer (Deque) Useful for IO, or as a bounded-size alternative to {!Queue} when batch operations are needed. diff --git a/src/data/CCSimple_queue.mli b/src/data/CCSimple_queue.mli index 1f5c599b..34efcca0 100644 --- a/src/data/CCSimple_queue.mli +++ b/src/data/CCSimple_queue.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Functional queues (fifo)} *) +(** Functional queues (fifo) *) (** Simple implementation of functional queues @since 1.3 *) diff --git a/src/data/CCTrie.mli b/src/data/CCTrie.mli index 53de1873..eb085c3b 100644 --- a/src/data/CCTrie.mli +++ b/src/data/CCTrie.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Prefix Tree} *) +(** Prefix Tree *) type 'a iter = ('a -> unit) -> unit type 'a ktree = unit -> [`Nil | `Node of 'a * 'a ktree list] diff --git a/src/data/CCWBTree.mli b/src/data/CCWBTree.mli index 4518ff81..d2658d1d 100644 --- a/src/data/CCWBTree.mli +++ b/src/data/CCWBTree.mli @@ -1,6 +1,6 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 Weight-Balanced Tree} +(** Weight-Balanced Tree {b status: experimental} diff --git a/src/data/CCZipper.mli b/src/data/CCZipper.mli index 411eb302..0c03dc56 100644 --- a/src/data/CCZipper.mli +++ b/src/data/CCZipper.mli @@ -1,7 +1,7 @@ (* This file is free software, part of containers. See file "license" for more details. *) -(** {1 List Zipper} +(** List Zipper @since 1.0 *)