Skip to content

BSL003 — Non export methods in API regions

← All rules

Summary

Non export methods in API regions

Identifiers

Field Value
Rule code BSL003
Compatible alias NonExportMethodsInApiRegion
Severity INFORMATION
Enabled by default Yes
Implemented Yes
Tags design, api

Behavior

  • The public identifier BSL003 and alias NonExportMethodsInApiRegion are stable.
  • The rule reports the cases documented on this page.
  • Suppressions and project configuration are applied before publication.
  • The rule requires neither an external analyzer nor network access.

Configuration and suppression

BSL### is the primary stable identifier. The compatible alias is accepted in select, ignore, and compatible block suppression comments.

[tool.onec-hbk-bsl]
select = ["BSL003"]
ignore = ["NonExportMethodsInApiRegion"]

All three suppression families support both a current line and a range. When an opening comment follows code, it affects only that line. Use any one form:

  • noqa:
Value = "example";  // noqa: BSL003
  • bsl-disable:
Value = "example";  // bsl-disable: BSL003
  • compatible BSLLS form:
Value = "example";  // BSLLS:NonExportMethodsInApiRegion-off

When the same opening comment is on a line by itself, it starts a range. Close it with the matching marker from the same family:

// noqa: BSL003
// code without this diagnostic
// noqa-enable: BSL003

// bsl-disable: BSL003
// code without this diagnostic
// bsl-enable: BSL003

// BSLLS:NonExportMethodsInApiRegion-off
// code without this diagnostic
// BSLLS:NonExportMethodsInApiRegion-on

To disable the rule until the end of the file, omit the closing noqa-enable, bsl-enable, or BSLLS:…-on marker.

Opening and closing markers must belong to the same family.

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.

Sources