Skip to content

Commit

Permalink
added more useful spec info to functions which return a list of binar…
Browse files Browse the repository at this point in the history
…y data, documentation-only change
  • Loading branch information
Caolan McMahon committed Aug 22, 2009
1 parent 5731eb9 commit d9c4dd7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/erlmpd.erl
Expand Up @@ -192,7 +192,7 @@ idle(C=#mpd_conn{}, Subsystems) ->
end.

%%-------------------------------------------------------------------
%% @spec (mpd_conn()) -> list()
%% @spec (mpd_conn()) -> [atom()]
%% @doc
%% Waits until there is a noteworthy change in any of MPD's subsystems.
%% Same as calling idle(C=#mpd_conn{}, []).
Expand Down Expand Up @@ -526,7 +526,7 @@ moveid(C=#mpd_conn{}, From, To) ->
])).

%%-------------------------------------------------------------------
%% @spec (mpd_conn()) -> list()
%% @spec (mpd_conn()) -> [binary()]
%% @doc
%% Displays the current playlist.
%% <strong>Note:</strong> Do not use this, instead use playlistinfo.
Expand Down Expand Up @@ -685,7 +685,7 @@ swapid(C=#mpd_conn{}, SongId1, SongId2) ->
%% Stored playlists
%%===================================================================
%%-------------------------------------------------------------------
%% @spec (mpd_conn(), Name::string()) -> list()
%% @spec (mpd_conn(), Name::string()) -> [binary()]
%% @doc
%% Lists the files in the playlist Name.m3u.
%% @end
Expand Down Expand Up @@ -1025,7 +1025,7 @@ outputs(C=#mpd_conn{}) -> parse_outputs(command(C, "outputs")).
%% Reflection
%%===================================================================
%%-------------------------------------------------------------------
%% @spec (mpd_conn()) -> list()
%% @spec (mpd_conn()) -> [binary()]
%% @doc
%% Shows which commands the current user has access to
%% @end
Expand All @@ -1034,7 +1034,7 @@ commands(C=#mpd_conn{}) ->
get_all(command, command(C, "commands")).

%%-------------------------------------------------------------------
%% @spec (mpd_conn()) -> list()
%% @spec (mpd_conn()) -> [binary()]
%% @doc
%% Shows which commands the current user does not have access to
%% @end
Expand All @@ -1052,7 +1052,7 @@ tagtypes(C=#mpd_conn{}) ->
get_all(tagtype, command(C, "tagtypes")).

%%-------------------------------------------------------------------
%% @spec (mpd_conn()) -> list()
%% @spec (mpd_conn()) -> [binary()]
%% @doc
%% Gets a list of available URL handlers.
%% @end
Expand Down

0 comments on commit d9c4dd7

Please sign in to comment.