From 96ff72437cc1cbea49fe9599048ab61a4d11fde8 Mon Sep 17 00:00:00 2001 From: rich Date: Fri, 25 Nov 2005 14:08:46 +0000 Subject: [PATCH] Bumped version for release and prepared and fixed documentation. --- .cvsignore | 3 ++- Makefile | 15 ++++++++++++--- csv.mli | 11 ++++++----- 3 files changed, 20 insertions(+), 9 deletions(-) diff --git a/.cvsignore b/.cvsignore index 098b8f2..105c635 100644 --- a/.cvsignore +++ b/.cvsignore @@ -6,4 +6,5 @@ test example csvtool -ocaml-csv-*.tar.gz \ No newline at end of file +ocaml-csv-*.tar.gz +html diff --git a/Makefile b/Makefile index c955e9b..6d30f56 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ -# $Id: Makefile,v 1.6 2005-08-25 16:25:04 rich Exp $ +# $Id: Makefile,v 1.7 2005-11-25 14:08:46 rich Exp $ PACKAGE := ocaml-csv -VERSION := 1.0.4 +VERSION := 1.1.0 OCAMLC := ocamlc OCAMLCINCS := @@ -16,6 +16,8 @@ OCAMLOPTLIBS := OBJS := csv.cmo XOBJS := $(OBJS:.cmo=.cmx) +OCAMLDOCFLAGS := -html -stars -sort $(OCAMLCINCS) + all: csv.cma csv.cmxa example csvtool csv.cma: $(OBJS) @@ -85,4 +87,11 @@ check-manifest: rm -f .orig-manifest .check-manifest; \ exit $$rv -.PHONY: depend dist check-manifest +# Developer documentation (in html/ subdirectory). + +doc: + rm -rf html + mkdir html + -ocamlfind ocamldoc $(OCAMLDOCFLAGS) -d html csv.ml{i,} + +.PHONY: depend dist check-manifest doc diff --git a/csv.mli b/csv.mli index a8e570d..baf9e5c 100644 --- a/csv.mli +++ b/csv.mli @@ -1,6 +1,6 @@ (** csv.mli - comma separated values parser * - * $Id: csv.mli,v 1.6 2005-11-25 14:06:58 rich Exp $ + * $Id: csv.mli,v 1.7 2005-11-25 14:08:46 rich Exp $ *) type t = string list list @@ -69,7 +69,7 @@ val square : t -> t (** Make the CSV data "square" (actually rectangular). This pads out * each row with empty cells so that all rows are the same length as * the longest row. After this operation, every row will have length - * {!columns}. + * {!Csv.columns}. *) val is_square : t -> bool @@ -133,7 +133,7 @@ val associate : string list -> t -> (string * string) list list * etc. ] * v} * - * Each row is turned into an assoc list (see {!List.assoc}). + * Each row is turned into an assoc list (see [List.assoc]). * * If a row is too short, it is padded with empty cells ([""]). If * a row is too long, it is truncated. @@ -161,9 +161,10 @@ val save : ?separator:char -> string -> t -> unit val print_readable : t -> unit (** Print the CSV data to [stdout] in a human-readable format. Not much * is guaranteed about how the CSV is printed, except that it will be - * easier to follow than a "raw" output done with {!print}. This is + * easier to follow than a "raw" output done with {!Csv.print}. This is * a one-way operation. There is no easy way to parse the output of * this command back into CSV data. *) val save_out_readable : out_channel -> t -> unit -(** As for {!print_readable}, allowing the output to be sent to a channel. *) +(** As for {!Csv.print_readable}, allowing the output to be sent to a channel. + *) -- 1.8.3.1