Skip to content

Commit 1a7d56d

Browse files
committed
Documentation correction for CASE_SENSE_NAMES
In issue #8129 the problem of using different case of filenames was addressed, though in the documentation it was not clear what this meant for input files. This has been corrected (the underlying problem has been handled with different other commits a.o. 2b5a454 ).
1 parent bfe598c commit 1a7d56d

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

src/config.xml

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -981,12 +981,17 @@ Go to the <a href="commands.html">next</a> section or return to the
981981
<option type='bool' id='CASE_SENSE_NAMES' defval='0' altdefval='Portable::fileSystemIsCaseSensitive()'>
982982
<docs>
983983
<![CDATA[
984-
If the \c CASE_SENSE_NAMES tag is set to \c NO then doxygen
985-
will only generate file names in lower-case letters. If set to
986-
\c YES, upper-case letters are also allowed. This is useful if you have
987-
classes or files whose names only differ in case and if your file system
988-
supports case sensitive file names. Windows (including Cygwin) and
989-
Mac users are advised to set this option to \c NO.
984+
With \c CASE_SENSE_NAMES doxygen will be better able to match the
985+
capabilities of the underlying file system.
986+
In case the files system supports files whose name only differs in the
987+
case used, the option must be set to \c YES to properly deal with such input files
988+
if they appear in the input, whereas for file systems that are not case
989+
sensitive the option should be be set to \c NO to properly deal with output files
990+
for symbols that only differ in case, like two classes one named \c CLASS
991+
and the other named \c Class and to support references to files without
992+
having to specify the correct case.
993+
994+
On Windows (including Cygwin) and Mac users are advised to set this option to \c NO.
990995
]]>
991996
</docs>
992997
</option>

0 commit comments

Comments
 (0)