RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346)
This commit is contained in:
parent
99eefa300d
commit
f7904cebe7
8
rules/S100/abap/parameters.adoc
Normal file
8
rules/S100/abap/parameters.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description: Regular expression used to check the [method|function|subroutine] names against
|
||||
* Default: ^([A-Z0-9_]*|[a-z0-9_]*)$
|
||||
* Type: STRING
|
||||
|
||||
|
@ -19,6 +19,15 @@ ENDMETHOD.
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
@ -15,6 +15,13 @@ public void doSomething(){...}
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
8
rules/S100/cfamily/parameters.adoc
Normal file
8
rules/S100/cfamily/parameters.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* description = Regular expression used to check the function names against
|
||||
* default = ^[a-z][a-zA-Z0-9]*$
|
||||
* type = STRING
|
||||
|
||||
|
@ -15,6 +15,15 @@ void doSomething (void);
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
@ -29,6 +29,13 @@ void My_method_(){...} // invalid, leading and trailing underscores are reported
|
||||
https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/capitalization-conventions[Microsoft Capitalization Conventions]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
8
rules/S100/flex/parameters.adoc
Normal file
8
rules/S100/flex/parameters.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description: Regular expression used to check the [method|function|subroutine] names against
|
||||
* Default value: ^[a-z][a-zA-Z0-9]*$
|
||||
* Type: STRING
|
||||
|
||||
|
@ -15,6 +15,15 @@ function doSomething(){...}
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
8
rules/S100/go/parameters.adoc
Normal file
8
rules/S100/go/parameters.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description: Regular expression used to check the function names against
|
||||
* Default value: ^[a-zA-Z0-9]+$
|
||||
* Type: STRING
|
||||
|
||||
|
@ -19,6 +19,15 @@ func executeAll() {
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
8
rules/S100/java/parameters.adoc
Normal file
8
rules/S100/java/parameters.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description: Regular expression used to check the method names against
|
||||
* Default value: ^[a-z][a-zA-Z0-9]*$
|
||||
* Type: STRING
|
||||
|
||||
|
@ -24,6 +24,15 @@ public int Do_Something(){...}
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
8
rules/S100/javascript/parameters.adoc
Normal file
8
rules/S100/javascript/parameters.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description: Regular expression used to check the [method|function|subroutine] names against
|
||||
* Default value: ^[_a-z][a-zA-Z0-9]*$
|
||||
* Type: STRING
|
||||
|
||||
|
@ -15,6 +15,15 @@ function doSomething(){...}
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
@ -1,6 +1,13 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S100/message.adoc
Normal file
4
rules/S100/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Rename [method|function|subroutine] "XXXX" to match the regular expression ${format}.
|
||||
|
7
rules/S100/php/parameters.adoc
Normal file
7
rules/S100/php/parameters.adoc
Normal file
@ -0,0 +1,7 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description: Regular expression used to check the [method|function|subroutine] names against
|
||||
* Default: ^[a-z][a-zA-Z0-9]*$
|
||||
|
||||
|
@ -30,6 +30,15 @@ function myFunc(){...}
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
8
rules/S100/python/parameters.adoc
Normal file
8
rules/S100/python/parameters.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* description = Regular expression used to check the [method|function|subroutine] names against
|
||||
* default = ^[a-z_][a-z0-9_]*$
|
||||
* type = STRING
|
||||
|
||||
|
@ -19,6 +19,15 @@ class MyClass:
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
7
rules/S100/rpg/parameters.adoc
Normal file
7
rules/S100/rpg/parameters.adoc
Normal file
@ -0,0 +1,7 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description: Regular expression used to check the subroutine names against
|
||||
* Default: ^SR[a-zA-Z0-9]*$
|
||||
|
||||
|
@ -33,6 +33,15 @@ C ENDSR
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
8
rules/S100/ruby/parameters.adoc
Normal file
8
rules/S100/ruby/parameters.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description: Regular expression used to check the function
|
||||
* Default: [a-z_][a-z0-9_]\{2,}$
|
||||
* Type: STRING
|
||||
|
||||
|
@ -1,6 +1,15 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
@ -19,6 +19,13 @@ def doSomething( ) : Unit = {
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
8
rules/S100/swift/parameters.adoc
Normal file
8
rules/S100/swift/parameters.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description: Regular expression used to check the function names against
|
||||
* Default value: ^[a-z][a-zA-Z0-9]*$
|
||||
* Type: STRING
|
||||
|
||||
|
@ -1,6 +1,15 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1002/cfamily/message.adoc
Normal file
4
rules/S1002/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Declaration of "xxx" is not introduced by the using-declaration on line "yyy".
|
||||
|
@ -8,6 +8,13 @@ This rule is a strict implementation of a MISRA (Motor Industry Software Reliabi
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
6
rules/S1003/cfamily/message.adoc
Normal file
6
rules/S1003/cfamily/message.adoc
Normal file
@ -0,0 +1,6 @@
|
||||
=== Message
|
||||
|
||||
Remove this using-directive.
|
||||
|
||||
Remove this using-declaration.
|
||||
|
@ -59,6 +59,13 @@ The issue only happens if the using directive is at global scope or at namespace
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1005/plsql/message.adoc
Normal file
4
rules/S1005/plsql/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Remove this "RETURN" statement.
|
||||
|
@ -19,6 +19,13 @@ END;
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
@ -61,6 +61,13 @@ int main() {
|
||||
include::../see.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
7
rules/S1006/csharp/message.adoc
Normal file
7
rules/S1006/csharp/message.adoc
Normal file
@ -0,0 +1,7 @@
|
||||
=== Message
|
||||
|
||||
* Use the default parameter value defined in the overridden method.
|
||||
* Remove the default parameter value to match the signature of overridden method.
|
||||
* Add the default parameter value defined in the overridden method.
|
||||
* Remove the default parameter value from this explicit interface implementation.
|
||||
|
@ -80,6 +80,13 @@ public class Program
|
||||
include::../see.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1006/message.adoc
Normal file
4
rules/S1006/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Remove the default value for parameter "xxx" or set it to the same value as in the base class.
|
||||
|
4
rules/S1009/cfamily/message.adoc
Normal file
4
rules/S1009/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Replace the enum type "xxx" with a type which is explicitly "signed" or "unsigned".
|
||||
|
@ -26,3 +26,12 @@ struct S
|
||||
* MISRA {cpp}:2008, 9-6-3 - Bit-fields shall not have enum type.
|
||||
* ISO/IEC 14882:2003
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
endif::env-github,rspecator-view[]
|
||||
|
7
rules/S101/abap/parameters.adoc
Normal file
7
rules/S101/abap/parameters.adoc
Normal file
@ -0,0 +1,7 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description : Regular expression used to check the class names against.
|
||||
* Default: ^([A-Z0-9_]*|[a-z0-9_]*)$
|
||||
|
||||
|
@ -19,6 +19,15 @@ ENDCLASS.
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
@ -15,6 +15,13 @@ class MyClass {}
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
8
rules/S101/cfamily/parameters.adoc
Normal file
8
rules/S101/cfamily/parameters.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* description = Regular expression used to check the class names against.
|
||||
* default = ^[A-Z][a-zA-Z0-9]*$
|
||||
* type = STRING
|
||||
|
||||
|
@ -31,6 +31,15 @@ class Foo // Compliant
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
5
rules/S101/csharp/message.adoc
Normal file
5
rules/S101/csharp/message.adoc
Normal file
@ -0,0 +1,5 @@
|
||||
=== Message
|
||||
|
||||
* Rename [class|interface|struct] "XXX" to match PascalCase naming rules, consider using "Xxx".
|
||||
* Rename [class|interface|struct] "XXX" to match PascalCase naming rules, trim underscores from the name.
|
||||
|
@ -31,6 +31,13 @@ class Some_Name_XC {...} // invalid because of XC, should be Some_Name_Xc
|
||||
* https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/capitalization-conventions[Microsoft Capitalization Conventions]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
7
rules/S101/flex/parameters.adoc
Normal file
7
rules/S101/flex/parameters.adoc
Normal file
@ -0,0 +1,7 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description : Regular expression used to check the class names against.
|
||||
* Default value : ^[A-Z][a-zA-Z0-9]*$
|
||||
|
||||
|
@ -15,6 +15,15 @@ public class MyClass {...}
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
@ -21,6 +21,13 @@ type myStruct struct {...}
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
7
rules/S101/java/parameters.adoc
Normal file
7
rules/S101/java/parameters.adoc
Normal file
@ -0,0 +1,7 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description : Regular expression used to check the class names against.
|
||||
* Default value : ^[A-Z][a-zA-Z0-9]*$
|
||||
|
||||
|
@ -1,6 +1,15 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
7
rules/S101/javascript/parameters.adoc
Normal file
7
rules/S101/javascript/parameters.adoc
Normal file
@ -0,0 +1,7 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description : Regular expression used to check the class names against.
|
||||
* Default value : ^[A-Z][a-zA-Z0-9]*$
|
||||
|
||||
|
@ -5,6 +5,15 @@ include::../noncompliant.adoc[]
|
||||
include::../compliant.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
7
rules/S101/kotlin/parameters.adoc
Normal file
7
rules/S101/kotlin/parameters.adoc
Normal file
@ -0,0 +1,7 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description : Regular expression used to check the class names against.
|
||||
* Default value : ^[A-Z][a-zA-Z0-9]*$
|
||||
|
||||
|
@ -1,6 +1,15 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S101/message.adoc
Normal file
4
rules/S101/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Rename class "XXXX" to match the regular expression ${format}.
|
||||
|
7
rules/S101/php/parameters.adoc
Normal file
7
rules/S101/php/parameters.adoc
Normal file
@ -0,0 +1,7 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description : Regular expression used to check the class names against.
|
||||
* Default value : ^[A-Z][a-zA-Z0-9]*$
|
||||
|
||||
|
@ -1,6 +1,15 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
7
rules/S101/python/parameters.adoc
Normal file
7
rules/S101/python/parameters.adoc
Normal file
@ -0,0 +1,7 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* description = Regular expression used to check the class names against.
|
||||
* default = ^_?([A-Z_][a-zA-Z0-9]{empty}*|[a-z_][a-z0-9_]{empty}*)$
|
||||
|
||||
|
@ -32,6 +32,15 @@ class my_context_manager:
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
@ -19,6 +19,13 @@ end
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
@ -1,6 +1,13 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
7
rules/S101/swift/parameters.adoc
Normal file
7
rules/S101/swift/parameters.adoc
Normal file
@ -0,0 +1,7 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* Description : Regular expression used to check the class names against.
|
||||
* Default value : ^[A-Z][a-zA-Z0-9]*$
|
||||
|
||||
|
@ -1,6 +1,15 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S101/vbnet/message.adoc
Normal file
4
rules/S101/vbnet/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Rename this class to match the regular expression: "xxx".
|
||||
|
8
rules/S101/vbnet/parameters.adoc
Normal file
8
rules/S101/vbnet/parameters.adoc
Normal file
@ -0,0 +1,8 @@
|
||||
=== Parameters
|
||||
|
||||
* key = format
|
||||
* description = Regular expression used to check the class names against.
|
||||
* default = ^([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$
|
||||
* type = STRING
|
||||
|
||||
|
@ -25,6 +25,15 @@ End Class
|
||||
----
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
include::parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1011/cfamily/message.adoc
Normal file
4
rules/S1011/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Refactor this "virtual" inheritance.
|
||||
|
@ -15,6 +15,13 @@ class D: public virtual B {}; // Noncompliant, B is a virtual base
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1012/cfamily/message.adoc
Normal file
4
rules/S1012/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Remove the "virtual" specifier on class "xxx".
|
||||
|
@ -18,6 +18,13 @@ class D: public virtual A {}; // Noncompliant, D is not part of a diamond-shaped
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1013/cfamily/message.adoc
Normal file
4
rules/S1013/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Class "xxx" derives from class "yyy" but lacks the "virtual" modifier.
|
||||
|
@ -29,6 +29,13 @@ class C: public B1, B2, B3 {}; // Compliant, A is always virtual
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1014/cfamily/message.adoc
Normal file
4
rules/S1014/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
"xxx" defined in "yyy" clashes with definition in "zzz" in "filename" on line "line" and should be renamed.
|
||||
|
@ -44,6 +44,13 @@ For the purposes of this rule, visible function identifiers that form an overloa
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1015/cfamily/message.adoc
Normal file
4
rules/S1015/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
This definition of virtual function "xxx" clashes with an existing definition in class "yyy".
|
||||
|
@ -100,6 +100,13 @@ d.f1(); // also calls B1::foo "by dominance"
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1016/cfamily/message.adoc
Normal file
4
rules/S1016/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
{cpp}98 or {cpp}03: Annotate this function with "virtual".
|
||||
|
@ -39,6 +39,13 @@ class Derived : public Base
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1017/cfamily/highlighting.adoc
Normal file
4
rules/S1017/cfamily/highlighting.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Highlighting
|
||||
|
||||
``++= 0++``
|
||||
|
4
rules/S1017/cfamily/message.adoc
Normal file
4
rules/S1017/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Convert this pure "virtual" function to a "virtual" function with a definition, or completely remove its declaration.
|
||||
|
@ -42,6 +42,15 @@ struct B : A {
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
include::highlighting.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1019/cfamily/message.adoc
Normal file
4
rules/S1019/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Remove this [use of "typeid"|use of "dynamic_cast"|virtual call to method "xxx"]
|
||||
|
@ -42,6 +42,13 @@ public:
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1022/cfamily/message.adoc
Normal file
4
rules/S1022/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
This code within a copy constructor might not be executed and should be removed.
|
||||
|
@ -28,6 +28,13 @@ private:
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1023/cfamily/message.adoc
Normal file
4
rules/S1023/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Mark this copy constructor of an abstract class "protected" or "private".
|
||||
|
@ -57,6 +57,13 @@ void f1( B1 & b1, B1 & b2 )
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1025/cfamily/message.adoc
Normal file
4
rules/S1025/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Add an explicit copy constructor to this class.
|
||||
|
@ -32,6 +32,13 @@ void f ( A const & a1 )
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1026/cfamily/message.adoc
Normal file
4
rules/S1026/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Add an explicit copy assignment operator to this class.
|
||||
|
@ -39,6 +39,13 @@ void f ( A const & a1, A & a2 )
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1027/cfamily/message.adoc
Normal file
4
rules/S1027/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
Use a qualified-id or "this->" to access "xxx".
|
||||
|
@ -71,6 +71,13 @@ template class A<int32_t>;
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1028/cfamily/message.adoc
Normal file
4
rules/S1028/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
\[Operator|Function] "xxx" is declared after the template declaration.
|
||||
|
@ -49,6 +49,13 @@ int main ( )
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
4
rules/S1029/cfamily/message.adoc
Normal file
4
rules/S1029/cfamily/message.adoc
Normal file
@ -0,0 +1,4 @@
|
||||
=== Message
|
||||
|
||||
"xxx" is never instantiated. It should be removed or referenced at least once.
|
||||
|
@ -32,6 +32,13 @@ This rule does not apply to libraries.
|
||||
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::message.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
@ -1,6 +1,15 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::../parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
@ -1,6 +1,15 @@
|
||||
include::../rule.adoc[]
|
||||
|
||||
ifdef::env-github,rspecator-view[]
|
||||
|
||||
'''
|
||||
== Implementation Specification
|
||||
(visible only on this page)
|
||||
|
||||
include::../message.adoc[]
|
||||
|
||||
include::../parameters.adoc[]
|
||||
|
||||
'''
|
||||
== Comments And Links
|
||||
(visible only on this page)
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user