AutosarC++18_03-A15.4.5

Checked exceptions that could be thrown from a function shall be specified together with the function declaration and they shall be identical in all function declarations and for all its overriders

Required inputs: IR, StaticSemanticAnalysis

Possible Messages

Key	Text	Severity	Disabled
differing_documented	Documented exceptions differ from overridden method.	None	False
document_exception	Document checked exception {} using {}.	None	False
superfluous_documented	Documented exceptions {} probably never thrown.	None	False

Options

• This rule shares the following common options: exclude_in_macros, exclude_messages_in_system_headers, excludes, extend_exclude_to_macro_invocations, includes, justification_checker, languages, post_processing, provider, report_at, severity

• The following places define options that affect this rule: Stylechecks, Analysis-GlobalOptions

autosar_exception_model

autosar_exception_model : str = '18_03'

The default model for what counts as an checked / unchecked exception.

 

exclude_exception_base_classes

exclude_exception_base_classes : set[bauhaus.analysis.config.QualifiedName] = set()

Exclude issues for the exception types mentioned in this set of qualified names. Also excludes classes derived from those class names as well as pointers or references to any of these class types.

 

ignore_definitions_if_declaration_documented

ignore_definitions_if_declaration_documented : bool = False

Instead of requiring the documentation to be repeated for every declaration (including definition), with this option set, the rule only checks the non-defining declarations if at least one non-defining declaration exists.

 

include_template_instances

include_template_instances : bool = False

If true, also analyse thrown exceptions for template instances. There will only be a single combined violation for all template instances, checking that the documented exceptions match the union of exceptions thrown by the template instances. This treatment corresponds to functions with function pointer arguments. For AUTOSAR compliance this option should be false. The AUTOSAR rule does not apply to templates, because a precise exception specification cannot be written.

 

match_qualified_name

match_qualified_name : bool = True

Matches the fully-qualified name when comparing documented exceptions with what can actually occur. If set to false, this rule will accept any suffix of the qualified name of an exception class as the documentation string.

 

throw_marker

throw_marker : str = '@throw'

The command to document an exception to be thrown.