Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.34 KB

NonExportMethodsInApiRegion.md

File metadata and controls

32 lines (21 loc) · 1.34 KB
Raw

Non export methods in API regions (NonExportMethodsInApiRegion)

Type Scope Severity Activated
by default		 Minutes
to fix		 Tags
Code smell BSL
OS		 Major Yes 1 standard

Description

  • The "API Interface" region contains export procedures and functions intended for use by other configuration objects or other programs (for example, via an external connection).

  • The “Service Programming Interface” region is intended for modules that are part of some functional subsystem. It should contain export procedures and functions that can only be called from other functional subsystems of the same library.

Reference

Snippets

Diagnostic ignorance in code

// BSLLS:NonExportMethodsInApiRegion-off
// BSLLS:NonExportMethodsInApiRegion-on

Parameter for config

"NonExportMethodsInApiRegion": false