From 8bf1bd07face1af84fbded1281e4877f28e0e9fa Mon Sep 17 00:00:00 2001
From: Hans Nilsson <hans@erlang.org>
Date: Thu, 27 Jun 2019 15:17:57 +0200
Subject: ssh: The ssh_sftpd documentation is now generated

---
 lib/ssh/doc/src/ssh_sftpd.xml | 33 ++++++++++-----------------------
 lib/ssh/src/ssh_sftpd.erl     | 12 +++++++++++-
 2 files changed, 21 insertions(+), 24 deletions(-)

diff --git a/lib/ssh/doc/src/ssh_sftpd.xml b/lib/ssh/doc/src/ssh_sftpd.xml
index ee72784add..0d7b340399 100644
--- a/lib/ssh/doc/src/ssh_sftpd.xml
+++ b/lib/ssh/doc/src/ssh_sftpd.xml
@@ -35,36 +35,23 @@
     <p>Specifies a channel process to handle an SFTP subsystem.</p>
   </description>
 
-  <section>
-    <title>DATA TYPES</title>
-    <taglist>
-      <tag><c>subsystem_spec() =</c></tag>
-      <item><p><c>{subsystem_name(), {channel_callback(), channel_init_args()}}</c></p></item>
-      <tag><c>subsystem_name() =</c></tag>
-      <item><p><c>"sftp"</c></p></item>
-      <tag><c>channel_callback() =</c></tag>
-      <item><p><c>atom()</c> - Name of the Erlang module implementing the subsystem using the
-      <seealso marker="ssh_server_channel">ssh_server_channel</seealso> (replaces ssh_daemon_channel) behaviour.</p></item>
-      <tag><c>channel_init_args() =</c></tag>
-      <item><p><c>list()</c> - The one given as argument to function <c>subsystem_spec/1</c>.</p></item>
-    </taglist>
-  </section>
   <funcs>
     <func>
-      <name since="">subsystem_spec(Options) -> subsystem_spec()</name>
+      <name name="subsystem_spec" arity="1" since=""/>
       <fsummary>Returns the subsystem specification that allows an SSH daemon to handle the subsystem "sftp".</fsummary>
-      <type>
-	<v>Options = [{Option, Value}]</v>
-      </type>
       <desc>
         <p>Is to be used together with <c>ssh:daemon/[1,2,3]</c></p>
+	<p>The <c>Name</c> is <c>"sftp"</c> and
+	<c>CbMod</c> is the name of the Erlang module implementing the subsystem using the
+	<seealso marker="ssh_server_channel">ssh_server_channel</seealso> (replaces ssh_daemon_channel) behaviour.
+	</p>
         <p>Options:</p>
         <taglist>
-          <tag><c><![CDATA[{cwd, String}]]></c></tag>
+          <tag><c>cwd</c></tag>
           <item>
             <p>Sets the initial current working directory for the server.</p>
           </item>
-          <tag><c><![CDATA[{file_handler, CallbackModule}]]></c></tag>
+          <tag><c>file_handler</c></tag>
           <item>
 	    <p>Determines which module to call for accessing
 	    the file server. The default value is <c>ssh_sftpd_file</c>, which uses the
@@ -72,13 +59,13 @@
 	    APIs to access the standard OTP file server. This option can be used to plug in
 	    other file servers.</p>
 	  </item>
-	  <tag><c><![CDATA[{max_files, Integer}]]></c></tag>
+	  <tag><c>max_files</c></tag>
 	  <item>
 	    <p>The default value is <c>0</c>, which means that there is no upper limit.
 	    If supplied, the number of filenames returned to the SFTP client per <c>READDIR</c>
 	    request is limited to at most the given value.</p>
 	  </item>
-	  <tag><c><![CDATA[{root, String}]]></c></tag>
+	  <tag><c>root</c></tag>
 	  <item>
 	    <p>Sets the SFTP root directory. Then the user cannot see any files
 	    above this root. If, for example, the root directory is set to <c>/tmp</c>,
@@ -86,7 +73,7 @@
 	    <c>cd /etc</c>, the user moves to <c>/tmp/etc</c>.
 	    </p>
 	  </item>
-	  <tag><c><![CDATA[{sftpd_vsn, integer()}]]></c></tag>
+	  <tag><c>sftpd_vsn</c></tag>
 	  <item>
 	    <p>Sets the SFTP version to use. Defaults to 5. Version 6 is under
 	    development and limited.</p>
diff --git a/lib/ssh/src/ssh_sftpd.erl b/lib/ssh/src/ssh_sftpd.erl
index 5ec12e2d04..bf921f0ff3 100644
--- a/lib/ssh/src/ssh_sftpd.erl
+++ b/lib/ssh/src/ssh_sftpd.erl
@@ -58,7 +58,17 @@
 %%====================================================================
 %% API
 %%====================================================================
--spec subsystem_spec(list()) -> subsystem_spec().
+-spec subsystem_spec(Options) -> Spec when
+      Options :: [ {cwd, string()} |
+                   {file_handler, CallbackModule::string()} |
+                   {max_files, integer()} |
+                   {root, string()} |
+                   {sftpd_vsn, integer()}
+                 ],
+      Spec :: {Name, {CbMod,Options}},
+      Name :: string(),
+      CbMod :: atom() .
+
 
 subsystem_spec(Options) ->
     {"sftp", {?MODULE, Options}}.
-- 
cgit v1.2.3