You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ide/include-cleanup-config.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -52,14 +52,14 @@ There are more options for configuring Include Cleanup such as excluding specifi
52
52
53
53
The `.editorconfig` settings that you can use with Include Cleanup are:
54
54
55
-
| Setting |Description |Values | Example |
55
+
| Setting | Values | Example |
56
56
|--|--|--|--|
57
-
|`cpp_include_cleanup_add_missing_error_tag_type`|Sets the error level of add transitive include messages. |`none`</br>`suggestion`</br>`warning`</br>`error`|`cpp_include_cleanup_add_missing_error_tag_type = suggestion`|
58
-
|`cpp_include_cleanup_remove_unused_error_tag_type`|Sets the error level of remove unused include messages. |`none`</br>`suggestion`</br>`warning`</br>`error`</br>`dimmed`|`cpp_include_cleanup_remove_unused_error_tag_type = dimmed`|
59
-
|`cpp_include_cleanup_excluded_files`|Excludes the specified files from Include Cleanup messages. You won’t get a suggestion related to the header at all, whether to add it or that it's unused. |*filename*|`cpp_include_cleanup_excluded_files = vcruntime.h, vcruntime_string.h`|
60
-
|`cpp_include_cleanup_required_files`|Specify that usage of *file1* requires *file2*. For example, specify that if you use `atlwin.h` that `altbase.h` must also be included. | file1:file2|`cpp_include_cleanup_required_files = atlwin.h:altbase.h, atlcom.h:altbase.h`|
61
-
|`cpp_include_cleanup_replacement_files`|Replaces *file1* with *file2*in messages. For example, you may prefer using `cstdio` over `stdio.h`. Include Cleanup messages referencing `stdio.h`instead indicate `cstdio`.|*file1*:*file2*|`cpp_include_cleanup_replacement_files = stdio.h:cstdio,stdint.h:cstdint`|
62
-
|`cpp_include_cleanup_alternate_files`|Don't generate a message for indirect include *file2* if *file1* is included. For example, if you `#include <windows.h>` and are only using something from its indirectly included header `winerror.h`, Include Cleanup won't prompt to add `winerror.h`. Useful when you prefer to include a facade header file instead of the indirect includes it contains. |*file1*:*file2*|`cpp_include_cleanup_alternate_files = windows.h:winerror.h, windows.h:minwindef.h`|
57
+
|`cpp_include_cleanup_add_missing_error_tag_type`</br></br>Sets the error level of add transitive include messages. |`none`</br>`suggestion`</br>`warning`</br>`error`|`cpp_include_cleanup_add_missing_error_tag_type = suggestion`|
58
+
|`cpp_include_cleanup_remove_unused_error_tag_type`</br></br>Sets the error level of remove unused include messages. |`none`</br>`suggestion`</br>`warning`</br>`error`</br>`dimmed`|`cpp_include_cleanup_remove_unused_error_tag_type = dimmed`|
59
+
|`cpp_include_cleanup_excluded_files`</br></br>Excludes the specified files from Include Cleanup messages. You won’t get a suggestion related to the header at all, whether to add it or that it's unused. |*filename*|`cpp_include_cleanup_excluded_files = vcruntime.h, vcruntime_string.h`|
60
+
|`cpp_include_cleanup_required_files`</br></br>Specify that usage of *file1* requires *file2*. For example, specify that if you use `atlwin.h` that `altbase.h` must also be included. |*file1*:*file2*|`cpp_include_cleanup_required_files = atlwin.h:altbase.h, atlcom.h:altbase.h`|
61
+
|`cpp_include_cleanup_replacement_files`</br></br>Replaces *file1* with *file2*during Include Cleanup processing. For example, you may prefer using `cstdio` over `stdio.h`. If you have a file with both `#include <cstudio>` and `#include <stdio.h>` and you consume content only from `stdio.h`, with this setting Include Cleanup will tell you to remove `stdio.h`because it replaced the usage of `cstdio` with `stdio.h` during processing. If you don't use the contents from either, Include Cleanup will tell you to remove both.|*file1*:*file2*|`cpp_include_cleanup_replacement_files = stdio.h:cstdio,stdint.h:cstdint`|
62
+
|`cpp_include_cleanup_alternate_files`</br></br>Don't generate a message for indirect include *file2* if *file1* is included. For example, if you `#include <windows.h>` and are only using something from its indirectly included header `winerror.h`, Include Cleanup won't prompt to add `winerror.h`. Useful when you prefer to include a facade header file instead of the indirect includes it contains. |*file1*:*file2*|`cpp_include_cleanup_alternate_files = windows.h:winerror.h, windows.h:minwindef.h`|
0 commit comments