Skip to content

Commit 9aad1eb

Browse files
committed
fix link, style edits
1 parent c40b196 commit 9aad1eb

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/code-quality/c6389.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ helpviewer_keywords: ["C6389"]
88

99
# C6389: MARK_INTERNAL_OR_MISSING_COMMON_DECL
1010

11-
This check intended to help with reducing the visibility of certain symbols and modularize the code. In multi-file C++ projects each declaration should be either local to a C++ file (part of the anonymous namespace) or declared in a common header file that is included by multiple C++ files.
11+
This check is intended to help reduce the visibility of certain symbols and to modularize the code. In multi-file C++ projects, each declaration should be either local to a C++ file (part of the anonymous namespace) or declared in a common header file that's included by multiple C++ files.
1212

13-
When this check flags a declaration, either it should be moved to an anonymous namespace or a forward declaration should be moved to a header file depending on the scope of the symbol.
13+
When this check flags a declaration, either it should be moved to an anonymous namespace or a forward declaration should be moved to a header file, depending on the scope of the symbol.
1414

15-
This is an experimental rule that needs to be enabled in a ruleset file explicitly to work. More information about rulesets can be found [here](https://docs.microsoft.com/en-us/visualstudio/code-quality/using-rule-sets-to-group-code-analysis-rules).
15+
The rule is an experimental rule that must be explicitly enabled in a rule set file to work. For more information about rule sets, see [Use rule sets to group code analysis rules](/visualstudio/code-quality/using-rule-sets-to-group-code-analysis-rules).
1616

1717
## Example
18+
1819
```cpp
1920
// A.h
2021
struct X;
@@ -28,7 +29,9 @@ struct Y { double y; }; // warning: Move 'Y' to anonymous namespace or put a for
2829

2930
void f(); // warning: Move 'Y' to anonymous namespace or put a forward declaration in a common header included in this file.
3031
```
32+
3133
To resolve this issue:
34+
3235
```cpp
3336
// A.h
3437
struct X;

0 commit comments

Comments
 (0)