Fix some doc strings to make edoc happy

This commit is contained in:
Kresten Krab Thorup 2012-05-07 22:53:05 +02:00
parent 3abc189680
commit 14dd00ad12
3 changed files with 9 additions and 6 deletions

View file

@ -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, [

View file

@ -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], []).

View file

@ -22,7 +22,7 @@
%%
%% ----------------------------------------------------------------------------
%% @Doc Drive a set of LSM BTrees
%% @doc Drive a set of LSM BTrees
-module(hanoidb_drv).
-behaviour(gen_server).