Skip to content

Commit

Permalink
Update config.xml
Browse files Browse the repository at this point in the history
Did rephrasing things a bit.
  • Loading branch information
doxygen committed Nov 2, 2020
1 parent 1a7d56d commit 9bbd3f5
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions src/config.xml
Expand Up @@ -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

This comment has been minimized.

Copy link
@albert-github

albert-github Nov 2, 2020

Collaborator

Not sure whether the word casing is correct (in dutch: "behuizing").

This comment has been minimized.

Copy link
@doxygen

doxygen Nov 2, 2020

Author Owner

I think it is in the context of programming, see also this discussion: https://english.stackexchange.com/questions/413690/is-casing-a-valid-alternative-to-capitalization

This comment has been minimized.

Copy link
@albert-github

albert-github Nov 2, 2020

Collaborator

I had the same doubts as OP of the mentioned question. For me it is not clear that "casing" has something to do with upper / lower case. In the mentioned question it typically refers to computing so it is OK but in other (technical) fields the word casing is used in the meaning of "a cover or shell that protects or encloses something" so it might be a bit confusing.

This comment has been minimized.

Copy link
@doxygen

doxygen Nov 2, 2020

Author Owner

"letter casing" is probably to full term here: https://en.wikipedia.org/wiki/Letter_case, but the "letter" part of often omitted if it is clear from the context.

This comment has been minimized.

Copy link
@albert-github

albert-github Nov 2, 2020

Collaborator

In the mentioned Wikipedia article there are indeed just references to the word casing as well in a similar sense as used in this description.

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.

This comment has been minimized.

Copy link
@albert-github

albert-github Nov 2, 2020

Collaborator

"typically set" should be "typically be set"

]]>
</docs>
</option>
Expand Down

0 comments on commit 9bbd3f5

Please sign in to comment.