Merge remote-tracking branch 'origin/main' into bigarray2

Makefile

@@ -3,5 +3,8 @@ all: build
 build:
 	@dune build
 
+doc:
+	@dune build @doc
+
 clean:
 	@dune clean

README.md

@@ -15,31 +15,23 @@ Basic usage is
 
 ```ocaml
 let () =
-  let filename = "test.mp3" in
-  let metadata = Metadata.parse_file filename in
+  let metadata = Metadata.parse_file "test.mp3" in
   List.iter (fun (k,v) -> Printf.printf "- %s: %s\n" k v) metadata
 ```
 
-In the above example, the function `Metadata.Any.parse_file` takes a file name
-as argument and returns an association list describing its metadata. It consists
-of pairs of strings being the name of the metadata and its value.
+In the above example, the function `Metadata.parse_file` takes a file name as
+argument and returns an association list describing its metadata. It consists of
+pairs of strings being the name of the metadata and its value.
 
 Installing
 ----------
 
 The preferred way is via opam:
 
 ```bash
-opam pin add .
 opam install metadata
 ```
 
-It can also be installed via dune:
-
-```
-dune install
-```
-
 Other libraries
 ---------------
 

examples/basic.ml

@@ -1,6 +1,5 @@
 (** Basic usage of the library. *)
 
 let () =
-  let filename = "test.mp3" in
-  let metadata = Metadata.parse_file filename in
-  List.iter (fun (k,v) -> Printf.printf "- %s: %s\n" k v) metadata
+  let metadata = Metadata.parse_file "test.mp3" in
+  List.iter (fun (k, v) -> Printf.printf "- %s: %s\n" k v) metadata

src/metadata.ml

@@ -11,6 +11,7 @@ module Make (E : CharEncoding.T) = struct
   module AVI = MetadataAVI
   module MP4 = MetadataMP4
 
+  (** Charset conversion function. *)
   let recode = E.convert
 
   module ID3 = struct
@@ -65,10 +66,16 @@ module Make (E : CharEncoding.T) = struct
 
   module Any = struct
     let parsers = Audio.parsers @ Image.parsers @ Video.parsers
+
+    (** Genering parsing of metadata. *)
     let parse = first_valid parsers
 
     let parse_file ?custom_parser file =
       Reader.with_file ?custom_parser parse file
+
+    (** Parse the metadatas of a string. *)
+    let parse_string ?custom_parser file =
+      Reader.with_string ?custom_parser parse file
   end
 
   include Any

src/metadata.mli

@@ -151,6 +151,9 @@ module Make : functor (_ : CharEncoding.T) -> sig
 
     val parse_file :
       ?custom_parser:custom_parser -> string -> MetadataBase.metadata
+
+    val parse_string :
+      ?custom_parser:custom_parser -> string -> MetadataBase.metadata
   end
 
   val parsers : (Reader.t -> MetadataBase.metadata) list

src/metadataBase.ml

@@ -16,6 +16,8 @@ type custom_parser =
   unit
 
 module Reader = struct
+  (** A function to read taking the buffer to fill the offset and the length and
+      returning the number of bytes actually read. *)
   type t = {
     read : bytes -> int -> int -> int;
     read_ba : (int -> bigarray) option;