51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
61 lines
1008 B
Plaintext
61 lines
1008 B
Plaintext
include::../rule.adoc[]
|
|
|
|
For example, with the default provided regular expression: ``++^[a-z][a-zA-Z0-9]*$++``, the function:
|
|
|
|
[source,cpp]
|
|
----
|
|
void DoSomething(); // Noncompliant
|
|
----
|
|
|
|
should be renamed to
|
|
|
|
[source,cpp]
|
|
----
|
|
void doSomething();
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
The rule ignores the names of:
|
|
|
|
* Overriding methods
|
|
* Template specializations
|
|
* When an interface expects a specific name (e.g., `begin` or `end` for range-based loops, `get<N>` for structural binding, etc.)
|
|
* Coroutines (S6193 covers them)
|
|
|
|
== Resources
|
|
|
|
=== Related rules
|
|
|
|
* S6193 - Coroutine names should comply with a naming convention
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.format
|
|
****
|
|
_STRING_
|
|
|
|
----
|
|
^[a-z][a-zA-Z0-9]*$
|
|
----
|
|
|
|
Regular expression used to check the function names against
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|