From 14dd00ad12ccfbbc211f6a929f2d4a75009c58cc Mon Sep 17 00:00:00 2001 From: Kresten Krab Thorup Date: Mon, 7 May 2012 22:53:05 +0200 Subject: [PATCH] Fix some doc strings to make edoc happy --- rebar.config | 2 +- src/hanoidb.erl | 11 +++++++---- test/hanoidb_drv.erl | 2 +- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/rebar.config b/rebar.config index 9c78636..c04b38e 100644 --- a/rebar.config +++ b/rebar.config @@ -2,7 +2,7 @@ {cover_enabled, true}. %% define 'PROPER' in stead if you must... -{erl_opts, [debug_info,{d,'TRIQ',true}]}. +{erl_opts, [debug_info,{d,'TRIQ',true},{parse_transform, lager_transform}]}. {deps, [ diff --git a/src/hanoidb.erl b/src/hanoidb.erl index f8fb644..4905498 100644 --- a/src/hanoidb.erl +++ b/src/hanoidb.erl @@ -60,18 +60,21 @@ | {read_buffer_size, pos_integer()} | {write_buffer_size, pos_integer()} | {merge_strategy, fast | predictable } + | {sync_strategy, none | sync | {seconds, pos_integer()}} . % @doc -% Create or open existing hanoidb store. Argument `Dir' names a +% Create or open a hanoidb store. Argument `Dir' names a % directory in which to keep the data files. By convention, we % name hanoidb data directories with extension ".hanoidb". -% @spec open(Dir::string()) -> pid(). -- spec open(Dir::string()) -> pid(). +% @spec open(Dir::string()) -> hanoidb() +- spec open(Dir::string()) -> hanoidb(). open(Dir) -> open(Dir, []). -- spec open(Dir::string(), Opts::[config_option()]) -> pid(). +% @doc Create or open a hanoidb store. +% @spec open(Dir::string(), Options::[config_option()]) -> hanoidb() +- spec open(Dir::string(), Opts::[config_option()]) -> hanoidb(). open(Dir, Opts) -> ok = start_app(), gen_server:start(?MODULE, [Dir, Opts], []). diff --git a/test/hanoidb_drv.erl b/test/hanoidb_drv.erl index d92471f..bfa9cb6 100644 --- a/test/hanoidb_drv.erl +++ b/test/hanoidb_drv.erl @@ -22,7 +22,7 @@ %% %% ---------------------------------------------------------------------------- -%% @Doc Drive a set of LSM BTrees +%% @doc Drive a set of LSM BTrees -module(hanoidb_drv). -behaviour(gen_server).