CNA-BUG-218: content_readers.h documentation names cna_get_last_error_message, which does not exist

CNA snapshot 009d40f5 · Known Issues › Current bugs · source links pinned to 009d40f5

✓

Evidence basis: source-verified at the pinned commit; tests exist (not executed for this page). Claims on this page were checked by reading the CNA source at commit 009d40f5; unless a sentence says otherwise, nothing here was built or executed. Nothing on this page was executed unless the Evidence section says so.

The Doxygen of cna_object_dictionary_ext_copy_value tells callers to read 'the message cna_get_last_error_message returns', a function declared nowhere; the C API's error accessors are the cna_error_* functions in core.h.

Identifier: CNA-BUG-218
Category: Bug
Subsystem: Documentation & release tooling
Status: Open
Verified against: CNA 009d40f5 (009d40f5dd085c4e674d3479675fac84b12b3e0a)
Severity: Low (a triage suggestion, not a project priority)
Evidence basis: Source-verified: read at TARGET, not executed
Tests touching this area: Yes: see Current tests
Affected contract: cna_object_dictionary_ext_copy_value documentation in CNA/C/content_readers.h

Expected behaviour

Public C API documentation names functions that exist: cna_error_get_last_info, cna_error_get_last_message_size and cna_error_copy_last_message.

Actual behaviour at TARGET

The comment distinguishing an absent key from a wrong kind says “the message cna_get_last_error_message returns is what separates them”; that identifier appears nowhere else in the tree.

Source locations

modules/c-api/include/CNA/C/content_readers.h — cna_object_dictionary_ext_copy_value Doxygen
modules/c-api/include/CNA/C/core.h — cna_error_get_last_info, cna_error_get_last_message_size, cna_error_copy_last_message

Evidence

Checked by reading content_readers.h and core.h, and by a git grep of the identifier at 009d40f5 (one hit, the comment). Not executed.

Focused reproduction

No focused reproduction is known. Nothing has been invented here; the evidence above is what exists.

Current tests

No check validates identifiers mentioned in C API Doxygen prose.

Regression test

Replace the name with the cna_error_* accessors; a Doxygen reference (@ref) would let the documentation build catch the next rename.

Blast radius

Readers of the C API reference for object-dictionary readers; no behaviour is affected.

Workaround

Use cna_error_get_last_message_size and cna_error_copy_last_message.

The same subject is explained at several altitudes. These are the neighbouring pages at each one.

User guide: C API: the model
Internals: C API internals: conventions
Maintainer workflow: Debugging: bindings and CMake
Known issues: Bug index