Add dscanner.ini, tweak documentation

Author: dd86k

dscanner.ini

@@ -0,0 +1,105 @@
+; Configure which static analysis checks are enabled
+[analysis.config.StaticAnalysisConfig]
+; Check variable, class, struct, interface, union, and function names against the Phobos style guide
+style_check="enabled"
+; Check for array literals that cause unnecessary allocation
+enum_array_literal_check="enabled"
+; Check for poor exception handling practices
+exception_check="enabled"
+; Check for use of the deprecated 'delete' keyword
+delete_check="enabled"
+; Check for use of the deprecated floating point operators
+float_operator_check="enabled"
+; Check number literals for readability
+number_style_check="enabled"
+; Checks that opEquals, opCmp, toHash, and toString are either const, immutable, or inout.
+object_const_check="enabled"
+; Checks for .. expressions where the left side is larger than the right.
+backwards_range_check="enabled"
+; Checks for if statements whose 'then' block is the same as the 'else' block
+if_else_same_check="enabled"
+; Checks for some problems with constructors
+constructor_check="enabled"
+; Checks for unused variables
+unused_variable_check="enabled"
+; Checks for unused labels
+unused_label_check="enabled"
+; Checks for unused function parameters
+unused_parameter_check="enabled"
+; Checks for duplicate attributes
+duplicate_attribute="enabled"
+; Checks that opEquals and toHash are both defined or neither are defined
+opequals_tohash_check="enabled"
+; Checks for subtraction from .length properties
+length_subtraction_check="enabled"
+; Checks for methods or properties whose names conflict with built-in properties
+builtin_property_names_check="enabled"
+; Checks for confusing code in inline asm statements
+asm_style_check="enabled"
+; Checks for confusing logical operator precedence
+logical_precedence_check="enabled"
+; Checks for undocumented public declarations
+undocumented_declaration_check="enabled"
+; Checks for poor placement of function attributes
+function_attribute_check="enabled"
+; Checks for use of the comma operator
+comma_expression_check="enabled"
+; Checks for local imports that are too broad. Only accurate when checking code used with D versions older than 2.071.0
+local_import_check="disabled"
+; Checks for variables that could be declared immutable
+could_be_immutable_check="enabled"
+; Checks for redundant expressions in if statements
+redundant_if_check="enabled"
+; Checks for redundant parenthesis
+redundant_parens_check="enabled"
+; Checks for mismatched argument and parameter names
+mismatched_args_check="enabled"
+; Checks for labels with the same name as variables
+label_var_same_name_check="enabled"
+; Checks for lines longer than `max_line_length` characters
+long_line_check="enabled"
+; Checks for assignment to auto-ref function parameters
+auto_ref_assignment_check="enabled"
+; Checks for incorrect infinite range definitions
+incorrect_infinite_range_check="enabled"
+; Checks for asserts that are always true
+useless_assert_check="enabled"
+; Check for uses of the old-style alias syntax
+alias_syntax_check="enabled"
+; Checks for else if that should be else static if
+static_if_else_check="enabled"
+; Check for unclear lambda syntax
+lambda_return_check="enabled"
+; Check for auto function without return statement
+auto_function_check="enabled"
+; Check for sortedness of imports
+imports_sortedness="disabled"
+; Check for explicitly annotated unittests
+explicitly_annotated_unittests="disabled"
+; Check for properly documented public functions (Returns, Params)
+properly_documented_public_functions="disabled"
+; Check for useless usage of the final attribute
+final_attribute_check="enabled"
+; Check for virtual calls in the class constructors
+vcall_in_ctor="enabled"
+; Check for useless user defined initializers
+useless_initializer="disabled"
+; Check allman brace style
+allman_braces_check="disabled"
+; Check for redundant attributes
+redundant_attributes_check="enabled"
+; Check public declarations without a documented unittest
+has_public_example="disabled"
+; Check for asserts without an explanatory message
+assert_without_msg="disabled"
+; Check indent of if constraints
+if_constraints_indent="disabled"
+; Check for @trusted applied to a bigger scope than a single function
+trust_too_much="enabled"
+; Check for redundant storage classes on variable declarations
+redundant_storage_classes="enabled"
+; Check for unused function return values
+unused_result="enabled"
+; Enable cyclomatic complexity check
+cyclomatic_complexity="disabled"
+

source/sha3d.d

@@ -5,7 +5,7 @@
 module sha3d;
 
 /// Version string of sha3-d that can be used for printing purposes.
-public enum SHA3D_VERSION_STRING = "1.3.0-dev";
+public enum SHA3D_VERSION_STRING = "1.3.0";
 
 private import std.digest;
 private import core.bitop : rol, bswap;
@@ -222,8 +222,8 @@ public struct KECCAK(uint digestSize,
 
     version (SHA3D_Trace) // For tests anyway
     {
-        uint round_counter;
-        bool verbose;
+        uint round_counter; // @suppress(dscanner.style.undocumented_declaration)
+        bool verbose; // @suppress(dscanner.style.undocumented_declaration)
     }
 
     /// Initiate or reset the state of the instance.
@@ -233,13 +233,14 @@ public struct KECCAK(uint digestSize,
     }
 
     version (SHA3D_Trace)
-    void enable_verbose()
+    void enable_verbose() // @suppress(dscanner.style.undocumented_declaration)
     {
         verbose = true;
         writeln("keccak.init capacity=", capacity, " rate=", rate, " statesz=", state8Size);
     }
 
     /// Feed the algorithm with data.
+    ///
     /// Also implements the $(REF isOutputRange, std,range,primitives)
     /// interface for `ubyte` and `const(ubyte)[]`.
     /// Params: input = Input data to digest
@@ -283,8 +284,9 @@ public struct KECCAK(uint digestSize,
     }
 
     /// Returns the finished hash.
+    ///
     /// This also clears part of the state, leaving just the final digest.
-    /// Returns: Raw digest data.
+    /// Returns: Digest.
     ubyte[digestSizeBytes] finish()
     {
         // Mark delimiter at end of message and padding at the end of sponge.
@@ -785,7 +787,7 @@ version (SHA3D_Trace) {} else
         auto shake128_256Of(T...)(T data) { return digest!(SHAKE128_256, T)(data); }
 
         // SHAKE128("", 256) =
-        auto shake128_256empty = hexString!(
+        const auto shake128_256empty = hexString!(
             "7f9c2ba4e88f827d616045507605853ed73b8093f6efbc88eb1a6eacfa66ef26");
 
         // Using convenience alias
@@ -801,7 +803,7 @@ version (SHA3D_Trace) {} else
         auto shake256_512Of(T...)(T data) { return digest!(SHAKE256_512, T)(data); }
 
         // SHAKE256("", 512) =
-        auto shake256_512empty = hexString!(
+        const auto shake256_512empty = hexString!(
             "46b9dd2b0ba88d13233b3feb743eeb243fcd52ea62b81b82b50c27646ed5762f"~
             "d75dc4ddd8c0f200cb05019d67b592f6fc821c49479ab48640292eacb3b7c4be");