From 32fc7c368f26a3872670002932e4752d6a3a5cef Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Tue, 2 Jan 2018 16:53:43 +0100 Subject: [PATCH] Make it more clear that XRC version must be set Omitting the version can result in difficult to diagnose problems, so insist that it should be set in the format documentation. See #18033. --- docs/doxygen/overviews/xrc_format.h | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/docs/doxygen/overviews/xrc_format.h b/docs/doxygen/overviews/xrc_format.h index 187d8677d1..7a1a25fe8e 100644 --- a/docs/doxygen/overviews/xrc_format.h +++ b/docs/doxygen/overviews/xrc_format.h @@ -48,20 +48,9 @@ be accessed using XRCCTRL(). @section overview_xrcformat_root Resource Root Element The root element is always @c \. It has one optional attribute, @c -version. If set, it specifies version of the file. In absence of @c version -attribute, the default is @c "0.0.0.0". - -The version consists of four integers separated by periods. The first three -components are major, minor and release number of the wxWidgets release when -the change was introduced, the last one is revision number and is 0 for the -first incompatible change in given wxWidgets release, 1 for the second and so -on. The version changes only if there was an incompatible change introduced; -merely adding new kind of objects does not constitute incompatible change. - -At the time of writing, the latest version is @c "2.5.3.0". - -Note that even though @c version attribute is optional, it should always be -specified to take advantage of the latest capabilities: +version which, while optional, should always be set to the latest version. At +the time of writing, it is @c "2.5.3.0", so all XRC documents should look like +the following: @code @@ -70,6 +59,13 @@ specified to take advantage of the latest capabilities: @endcode +The version consists of four integers separated by periods. The first three +components are major, minor and release number of the wxWidgets release when +the change was introduced, the last one is revision number and is 0 for the +first incompatible change in given wxWidgets release, 1 for the second and so +on. The version changes only if there was an incompatible change introduced; +merely adding new kind of objects does not constitute incompatible change. + @c \ may have arbitrary number of @ref overview_xrcformat_objects "object elements" as its children; they are referred to as @em toplevel objects in the rest of this document. Unlike objects defined