ssh: Ctify test doc

1 files changed, 34 insertions, 34 deletions

diff --git a/lib/ssh/test/ssh_sftp_SUITE.erl b/lib/ssh/test/ssh_sftp_SUITE.erl
index ac93db8f2e..56b1363b7a 100644
--- a/lib/ssh/test/ssh_sftp_SUITE.erl
+++ b/lib/ssh/test/ssh_sftp_SUITE.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2005-2012. All Rights Reserved.
+%% Copyright Ericsson AB 2005-2013. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -158,8 +158,8 @@ end_per_testcase(Config) ->
 %%--------------------------------------------------------------------
 %% Test Cases --------------------------------------------------------
 %%--------------------------------------------------------------------
-open_close_file(doc) ->
-    ["Test API functions open/3 and close/2"];
+open_close_file() ->
+    [{doc, "Test API functions open/3 and close/2"}].
 open_close_file(Config) when is_list(Config) ->
     PrivDir =  ?config(priv_dir, Config),
     FileName = filename:join(PrivDir, "sftp.txt"),
@@ -178,8 +178,8 @@ open_close_file(Server, File, Mode) ->
     ok = ssh_sftp:close(Server, Handle).
 
 %%--------------------------------------------------------------------
-open_close_dir(doc) ->
-    ["Test API functions opendir/2 and close/2"];
+open_close_dir() ->
+    [{doc, "Test API functions opendir/2 and close/2"}].
 open_close_dir(Config) when is_list(Config) ->
     PrivDir = ?config(priv_dir, Config),
     {Sftp, _} = ?config(sftp, Config),
@@ -190,8 +190,8 @@ open_close_dir(Config) when is_list(Config) ->
     {error, _} =  ssh_sftp:opendir(Sftp, FileName).
 
 %%--------------------------------------------------------------------
-read_file(doc) ->
-    ["Test API funtion read_file/2"];
+read_file() ->
+    [{doc, "Test API funtion read_file/2"}].
 read_file(Config) when is_list(Config) ->
     PrivDir =  ?config(priv_dir, Config),
     FileName = filename:join(PrivDir, "sftp.txt"),
@@ -200,8 +200,8 @@ read_file(Config) when is_list(Config) ->
     {ok, Data} = file:read_file(FileName).
 
 %%--------------------------------------------------------------------
-read_dir(doc) ->
-    ["Test API function list_dir/2"];
+read_dir() ->
+    [{doc,"Test API function list_dir/2"}].
 read_dir(Config) when is_list(Config) ->
     PrivDir = ?config(priv_dir, Config),
     {Sftp, _} = ?config(sftp, Config),
@@ -209,8 +209,8 @@ read_dir(Config) when is_list(Config) ->
     ct:pal("sftp list dir: ~p~n", [Files]).
 
 %%--------------------------------------------------------------------
-write_file(doc) ->
-    ["Test API function write_file/2"];
+write_file() ->
+    [{doc, "Test API function write_file/2"}].
 write_file(Config) when is_list(Config) ->
     PrivDir =  ?config(priv_dir, Config),
     FileName = filename:join(PrivDir, "sftp.txt"),
@@ -221,8 +221,8 @@ write_file(Config) when is_list(Config) ->
     {ok, Data} = file:read_file(FileName).
 
 %%--------------------------------------------------------------------
-remove_file(doc) ->
-    ["Test API function delete/2"];
+remove_file() ->
+    [{doc,"Test API function delete/2"}].
 remove_file(Config) when is_list(Config) ->
     PrivDir =  ?config(priv_dir, Config),
     FileName = filename:join(PrivDir, "sftp.txt"),
@@ -235,8 +235,8 @@ remove_file(Config) when is_list(Config) ->
     false = lists:member(filename:basename(FileName), NewFiles),
     {error, _} = ssh_sftp:delete(Sftp, FileName).
 %%--------------------------------------------------------------------
-rename_file(doc) ->
-    ["Test API function rename_file/2"];
+rename_file() ->
+    [{doc, "Test API function rename_file/2"}].
 rename_file(Config) when is_list(Config) ->
     PrivDir =  ?config(priv_dir, Config),
     FileName = filename:join(PrivDir, "sftp.txt"),
@@ -255,8 +255,8 @@ rename_file(Config) when is_list(Config) ->
     true = lists:member(filename:basename(NewFileName), NewFiles).
 
 %%--------------------------------------------------------------------
-mk_rm_dir(doc) ->
-    ["Test API functions make_dir/2, del_dir/2"];
+mk_rm_dir() ->
+    [{doc,"Test API functions make_dir/2, del_dir/2"}].
 mk_rm_dir(Config) when is_list(Config) ->
     PrivDir = ?config(priv_dir, Config),
     {Sftp, _} = ?config(sftp, Config),
@@ -269,8 +269,8 @@ mk_rm_dir(Config) when is_list(Config) ->
     {error, _} = ssh_sftp:del_dir(Sftp, PrivDir).
 
 %%--------------------------------------------------------------------
-links(doc) ->
-    ["Tests API function make_symlink/3"];
+links() ->
+    [{doc,"Tests API function make_symlink/3"}].
 links(Config) when is_list(Config) ->
     case os:type() of
 	{win32, _} ->
@@ -286,8 +286,8 @@ links(Config) when is_list(Config) ->
     end.
 
 %%--------------------------------------------------------------------
-retrieve_attributes(doc) ->
-    ["Test API function read_file_info/3"];
+retrieve_attributes() ->
+    [{doc, "Test API function read_file_info/3"}].
 retrieve_attributes(Config) when is_list(Config) ->
     PrivDir =  ?config(priv_dir, Config),
     FileName = filename:join(PrivDir, "sftp.txt"),
@@ -300,8 +300,8 @@ retrieve_attributes(Config) when is_list(Config) ->
     ct:pal("SFTP: ~p   FILE: ~p~n", [FileInfo, NewFileInfo]).
 
 %%--------------------------------------------------------------------
-set_attributes(doc) ->
-    ["Test API function write_file_info/3"];
+set_attributes() ->
+    [{doc,"Test API function write_file_info/3"}].
 set_attributes(Config) when is_list(Config) ->
     PrivDir =  ?config(priv_dir, Config),
     FileName = filename:join(PrivDir, "test.txt"),
@@ -316,8 +316,8 @@ set_attributes(Config) when is_list(Config) ->
 
 %%--------------------------------------------------------------------
 
-async_read(doc) ->
-    ["Test API aread/3"];
+async_read() ->
+    [{doc,"Test API aread/3"}].
 async_read(Config) when is_list(Config) ->
     {Sftp, _} = ?config(sftp, Config),
     PrivDir =  ?config(priv_dir, Config),
@@ -334,8 +334,8 @@ async_read(Config) when is_list(Config) ->
 	    ct:fail(Msg)
     end.
 %%--------------------------------------------------------------------
-async_write(doc) ->
-    ["Test API awrite/3"];
+async_write() ->
+    [{doc,"Test API awrite/3"}].
 async_write(Config) when is_list(Config) ->
     {Sftp, _} = ?config(sftp, Config),
     PrivDir =  ?config(priv_dir, Config),
@@ -353,8 +353,8 @@ async_write(Config) when is_list(Config) ->
 
 %%--------------------------------------------------------------------
 
-position(doc) ->
-    ["Test API functions position/3"];
+position() ->
+    [{doc, "Test API functions position/3"}].
 position(Config) when is_list(Config) ->
     PrivDir =  ?config(priv_dir, Config),
     FileName = filename:join(PrivDir, "test.txt"),
@@ -383,8 +383,8 @@ position(Config) when is_list(Config) ->
     {ok, "2"} = ssh_sftp:read(Sftp, Handle, 1).
 
 %%--------------------------------------------------------------------
-pos_read(doc) ->
-    ["Test API functions pread/3 and apread/3"];
+pos_read() ->
+    [{doc,"Test API functions pread/3 and apread/3"}].
 pos_read(Config) when is_list(Config) ->
     PrivDir =  ?config(priv_dir, Config),
     FileName = filename:join(PrivDir, "test.txt"),
@@ -409,8 +409,8 @@ pos_read(Config) when is_list(Config) ->
     {ok, NewData1} = ssh_sftp:pread(Sftp, Handle, {bof, 4}, 4).
 
 %%--------------------------------------------------------------------
-pos_write(doc) ->
-    ["Test API functions pwrite/4 and apwrite/4"];
+pos_write() ->
+    [{doc,"Test API functions pwrite/4 and apwrite/4"}].
 pos_write(Config) when is_list(Config) ->
     PrivDir =  ?config(priv_dir, Config),
     FileName = filename:join(PrivDir, "test.txt"),
@@ -437,7 +437,7 @@ pos_write(Config) when is_list(Config) ->
 
 %%--------------------------------------------------------------------
 sftp_nonexistent_subsystem() ->
-    [""].
+    [{doc, "Try to execute sftp subsystem on a server that does not support it"}].
 sftp_nonexistent_subsystem(Config) when is_list(Config) ->
     {_,Host, Port} =  ?config(sftpd, Config),
     {error,"server failed to start sftp subsystem"} =