From 2ef7df964296046ad529c9a81ed12148071cb404 Mon Sep 17 00:00:00 2001 From: Francis Dupont Date: Thu, 16 Dec 2021 00:13:49 +0100 Subject: [#2084] Addressed all concerns outside .yy files --- doc/devel/doc.dox | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'doc/devel') diff --git a/doc/devel/doc.dox b/doc/devel/doc.dox index 1ae1bf33a7..cde7f9071c 100644 --- a/doc/devel/doc.dox +++ b/doc/devel/doc.dox @@ -65,12 +65,11 @@ means that some trickery with escaping double quotes will be involved. Note there is no need to escape any other character, unless you want to specify non-printable characters. -Also, while Kea's JSON parser supports comments, multi-line strings and extra -commas, they are not part of JSON standard. That means that external tools, such -as python or Sphinx parsers are not able to deal with them. Therefore comments -and extra commas must be removed. Long strings (such as command descriptions or -example invocations) are to be presented as a list of strings -e.g. [ "line1", "line2, "line3" ]. +Also, while Kea's JSON parser supports comments and multi-line string, they +are not part of JSON standard. That means that external tools, such as python +or Sphinx parsers are not able to deal with them. Therefore comments must +be removed and long strings (such as command descriptions or example invocations) +are to be presented as a list of strings ( e.g. [ "line1", "line2, "line3" ]). @section docsDevelGuide Generating Developer's Guide -- cgit v1.2.3