summaryrefslogtreecommitdiffstats
path: root/src/config.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/config.xml')
-rw-r--r--src/config.xml23
1 files changed, 13 insertions, 10 deletions
diff --git a/src/config.xml b/src/config.xml
index a97ab53..82e2afe 100644
--- a/src/config.xml
+++ b/src/config.xml
@@ -981,17 +981,20 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='CASE_SENSE_NAMES' defval='0' altdefval='Portable::fileSystemIsCaseSensitive()'>
<docs>
<![CDATA[
- With \c CASE_SENSE_NAMES doxygen will be better able to match the
- capabilities of the underlying file system.
- In case the files system supports files whose name only differs in the
- case used, the option must be set to \c YES to properly deal with such input files
- if they appear in the input, whereas for file systems that are not case
- sensitive the option should be be set to \c NO to properly deal with output files
- for symbols that only differ in case, like two classes one named \c CLASS
- and the other named \c Class and to support references to files without
- having to specify the correct case.
+ With the correct setting of option \c CASE_SENSE_NAMES doxygen will better be able to match the
+ capabilities of the underlying filesystem.
- On Windows (including Cygwin) and Mac users are advised to set this option to \c NO.
+ In case the filesystem is case sensitive (i.e. it supports files in the same directory
+ whose names only differ in casing), the option must be set to \c YES to properly deal with such files
+ in case they appear in the input.
+
+ For filesystems that are not case sensitive the option should be be set to \c NO to properly
+ deal with output files written for symbols that only differ in casing, such as for two classes,
+ one named \c CLASS and the other named \c Class, and to also support references to files without
+ having to specify the exact matching casing.
+
+ On Windows (including Cygwin) and MacOS, users should typically set this option to \c NO,
+ whereas on Linux or other Unix flavors it should typically set to \c YES.
]]>
</docs>
</option>