Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make it more clear that XRC version must be set

Browse Source 
Omitting the version can result in difficult to diagnose problems, so
insist that it should be set in the format documentation.

See #18033.
This commit is contained in:
Vadim Zeitlin
2018-01-02 16:53:43 +01:00
parent 0730236fa8
commit 32fc7c368f
1 changed files with 10 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/doxygen/overviews/xrc_format.h
View File

@@ -48,20 +48,9 @@ be accessed using XRCCTRL().
@section overview_xrcformat_root Resource Root Element
The root element is always @c \<resource\>. 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
<?xml version="1.0"?>
@@ -70,6 +59,13 @@ specified to take advantage of the latest capabilities:
</resource>
@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 \<resource\> 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