Mention wxFILE_EXISTS_NO_FOLLOW in wxFILE_EXISTS_SYMLINK description.

Using wxFILE_EXISTS_SYMLINK without wxFILE_EXISTS_NO_FOLLOW can only be
fruitless, so mention that they should normally be used together in the
documentation.

An alternative solution would be to always add wxFILE_EXISTS_NO_FOLLOW
automatically if wxFILE_EXISTS_SYMLINK is used, perhaps we should do this
instead.

See #14542.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72741 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/filename.h b/interface/wx/filename.h
index ffa57df4438b75e3bcdf5eaeb66a30fc077de508..3622c768997274aafd9c0aaada690d53979b96f5 100644 (file)
--- a/interface/wx/filename.h
+++ b/interface/wx/filename.h
@@ -99,7 +99,16 @@ enum
 {
     wxFILE_EXISTS_REGULAR   = 0x0001,  //!< Check for existence of a regular file
     wxFILE_EXISTS_DIR       = 0x0002,  //!< Check for existence of a directory
 {
     wxFILE_EXISTS_REGULAR   = 0x0001,  //!< Check for existence of a regular file
     wxFILE_EXISTS_DIR       = 0x0002,  //!< Check for existence of a directory

-    wxFILE_EXISTS_SYMLINK   = 0x0004,  //!< Check for existence of a symbolic link
+    /**
+        Check for existence of a symlink.
+
+        Notice that this flag should be used either with
+        ::wxFILE_EXISTS_NO_FOLLOW or with a wxFileName object on which
+        wxFileName::DontFollowLink() had been called, otherwise it would never
+        be satisfied as wxFileName::Exists() would be checking for the
+        existence of the symlink target and not the symlink itself.
+     */
+    wxFILE_EXISTS_SYMLINK   = 0x0004,

     wxFILE_EXISTS_DEVICE    = 0x0008,  //!< Check for existence of a device
     wxFILE_EXISTS_FIFO      = 0x0016,  //!< Check for existence of a FIFO
     wxFILE_EXISTS_SOCKET    = 0x0032,  //!< Check for existence of a socket
     wxFILE_EXISTS_DEVICE    = 0x0008,  //!< Check for existence of a device
     wxFILE_EXISTS_FIFO      = 0x0016,  //!< Check for existence of a FIFO
     wxFILE_EXISTS_SOCKET    = 0x0032,  //!< Check for existence of a socket