Ara
Download

Search or run a command

Jump to a section or open an Ara link.

Diagnostic code · ARA0703

Reflected declaration needs documentation

A reflected declaration has no usable documentation. Its text becomes Schema DB documentation, inspector tooltips and agent tool descriptions. Compilation fails; the last good module keeps running.

Common causes

  • A reflected type, field, property or enum variant lacks a nonempty XML summary.
  • A command parameter lacks its XML parameter documentation, or the command has no summary on the class or Execute method.

Fixes

  • Add a concise /// <summary> explaining the named declaration's meaning, units and usage where relevant.

  • Document command arguments with /// <param name="argument"> on Execute and add a command summary.

  • Code: ARA0703

  • Constant: cs::MISSING_DOC

  • Reported by: Ara.Generators