Skip to content

Commit

Permalink
fixed doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ddossot committed Sep 12, 2010
1 parent 00a903d commit 0e0c359
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/cferl_object.erl
Expand Up @@ -96,14 +96,14 @@ do_read_data_result(Other) ->

%% @doc Read the data stored for the current object and feed by chunks it into a function.
%% The function of arity 1 will receive: {error, Cause::term()} | {ok, Data:binary()} | eof
%% @spec read_data(DataFun::function()) -> ok | Error
%% @spec read_data_stream(DataFun::function()) -> ok | Error
%% Error = cferl_error()
read_data_stream(DataFun) when is_function(DataFun, 1) ->
do_read_data_stream(DataFun, []).

%% @doc Read the data stored for the current object, reading 'size' bytes from the 'offset', and feed by chunks it into a function.
%% The function of arity 1 will receive: {error, Cause::term()} | {ok, Data:binary()} | eof
%% @spec read_data(DataFun::function(), Offset::integer(), Size::integer()) -> ok | Error
%% @spec read_data_stream(DataFun::function(), Offset::integer(), Size::integer()) -> ok | Error
%% Error = cferl_error()
read_data_stream(DataFun, Offset, Size)
when is_function(DataFun, 1), is_integer(Offset), is_integer(Size) ->
Expand Down

0 comments on commit 0e0c359

Please sign in to comment.