[#10,!3] Syntax is now copied over correctly from json files to xml

 - it is now possible to use formatting in comments.

diff --git a/doc/api/config-set.json b/doc/api/config-set.json
index dd39e941320517d327f4a5a67b4ec0f5696187a0..b8b7b009273cea664b08d3c3923038bb83fadf2f 100644 (file)
--- a/doc/api/config-set.json
+++ b/doc/api/config-set.json
@@ -13,7 +13,7 @@
         }
      }
 }",
-    "cmd-comment": "where <server> is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"",
+    "cmd-comment": "where &lt;server&gt; is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"",
     "resp-syntax": "    {\"result\": 0, \"text\": \"Configuration successful.\" }
 
     or

diff --git a/doc/api/config-test.json b/doc/api/config-test.json
index 9f5daac5bec06b17fcf2f052196635e8b257d8b2..aa6ef357db22f9cb0e869f22c2d91c25d31e9c7d 100644 (file)
--- a/doc/api/config-test.json
+++ b/doc/api/config-test.json
@@ -13,7 +13,7 @@
         }
      }
 }",
-    "cmd-comment": "where <server> is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"",
+    "cmd-comment": "where &gt;server&lt; is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"",
     "resp-syntax": "{\"result\": 0, \"text\": \"Configuration seems sane...\" }
 
     or

diff --git a/doc/docgen/kea_docgen.cc b/doc/docgen/kea_docgen.cc
index a0d665e2e1d2e1e58be0e01f084bf6ba7fe165c9..3a9044e834cb5a1d5e97e32462df8068e17bdcdd 100644 (file)
--- a/doc/docgen/kea_docgen.cc
+++ b/doc/docgen/kea_docgen.cc
@@ -428,7 +428,7 @@ public:
               << "}</screen>" << endl;
         }
         if (cmd->contains("cmd-comment")) {
-            f << escapeString(cmd->get("cmd-comment")->stringValue());
+            f << cmd->get("cmd-comment")->stringValue();
         }
         f << "</para>" << endl << endl;
 

diff --git a/doc/guide/api.xml b/doc/guide/api.xml
index 98e4fd6dd085642dc4941061a681d0a193738d20..0383d34761a5b487cfa4ee8d2b32ed148e2927b0 100644 (file)
--- a/doc/guide/api.xml
+++ b/doc/guide/api.xml
@@ -573,7 +573,7 @@ Result is an integer representation of the status. Currently supported statuses
   <screen>{
     "command": "config-get"
 }</screen>
-&lt;command&gt;config-get&lt;/command&gt; takes no parameters.</para>
+<command>config-get</command> takes no parameters.</para>
 
 <para>Response syntax:
   <screen>{
@@ -691,7 +691,7 @@ Result is an integer representation of the status. Currently supported statuses
         }
      }
 }</screen>
-where &lt;server&gt; is the configuration element name for a given server such as "Dhcp4" or "Dhcp6"</para>
+where &gt;server&lt; is the configuration element name for a given server such as "Dhcp4" or "Dhcp6"</para>
 
 <para>Response syntax:
   <screen>{"result": 0, "text": "Configuration seems sane..." }
@@ -3011,9 +3011,9 @@ If no IPv6 subnets are found, an error code is returned along with the error des
 <!-- start of version-get -->
 <section xml:id="reference-version-get">
 <title>version-get reference</title>
-<para xml:id="ref-version-get"><command>version-get</command> - The version-get command returns on the control channel what the
-              command line -v argument displays with in arguments the extended
-              version, i.e., what the command line -V argument displays.</para>
+<para xml:id="ref-version-get"><command>version-get</command> - The version-get command returns extended information about
+              Kea version. The returned string is the same as if Kea would
+              be run with -V command line option.</para>
 
 <para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command>, <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command>, <command><link linkend="commands-kea-ctrl-agent">kea-ctrl-agent</link></command></para>