Permalink
Browse files

fixed documentation bugs

  • Loading branch information...
1 parent f014aa4 commit a039017eda539fbe94d4cd68866bad9fa8fd1ba7 @filippo committed Dec 14, 2007
Showing with 9 additions and 7 deletions.
  1. +3 −3 src/sgte.erl
  2. +6 −4 src/sgte_render.erl
View
@@ -1,4 +1,4 @@
-%%%-------------------------------------------------------------------
+
%%% File : sgte.erl
%%% Author : filippo pacini <pacini@sgconsulting.it>
%%%
@@ -193,15 +193,15 @@ render(Compiled, Data) ->
sgte_render:render(Compiled, Data).
%%--------------------------------------------------------------------
-%% @spec render_string(compiled(), data(), options()) -> string()
+%% @spec render_str(compiled(), data(), options()) -> string()
%% @doc Calls render/3 and converts the result to string.
%% @end
%%--------------------------------------------------------------------
render_str(Compiled, Data, Options) ->
sgte_render:render_str(Compiled, Data, Options).
%%--------------------------------------------------------------------
-%% @spec render_string(compiled(), data()) -> string()
+%% @spec render_str(compiled(), data()) -> string()
%% @doc Calls render/2 and converts the result to string.
%% @end
%%--------------------------------------------------------------------
View
@@ -40,15 +40,15 @@
render_bin/3]).
%%--------------------------------------------------------------------
-%% @spec render_string(compiled(), data(), options()) -> string()
+%% @spec render_str(compiled(), data(), options()) -> string()
%% @doc Calls render/3 and converts the result to string.
%% @end
%%--------------------------------------------------------------------
render_str(Compiled, Data, Options) ->
to_str(render(Compiled, Data, Options)).
%%--------------------------------------------------------------------
-%% @spec render_string(compiled(), data()) -> string()
+%% @spec render_str(compiled(), data()) -> string()
%% @doc Calls render/2 and converts the result to string.
%% @end
%%--------------------------------------------------------------------
@@ -129,7 +129,7 @@ to_str(DeepL) ->
lists:flatten(lists:map(ToStr, lists:flatten(DeepL))).
%%--------------------------------------------------------------------
-%% @spec to_binary(deep_list()) -> string()
+%% @spec to_bin(deep_list()) -> string()
%% @doc Gets a deep list with mixed strings and binaries. Converts
%% everything to binary and returns the flattened list.
%% @end
@@ -459,7 +459,9 @@ gettext_lc(Options) ->
end.
%%--------------------------------------------------------------------
-%% @spec printable(Term::term()) -> string()
+%% @spec printable(Term::term(), Else::function()) -> string()
+%% @doc Tries to convert an erlang term to string
+%% @end
%%--------------------------------------------------------------------
printable(Term, _Else) when is_integer(Term) ->
integer_to_list(Term);

0 comments on commit a039017

Please sign in to comment.