Skip to main content

resolve_inherited_param_markers

Function resolve_inherited_param_markers 

Source
fn resolve_inherited_param_markers(content: String) -> String
Expand description

Resolve .__MX_INHERITED_PARAM__(...) markers.

For each marker, checks whether the parent class is in-package and has @param <param> documented for either:

  • The same method name (in any of its method doc blocks), or
  • The class-level @param (emitted in the class header).

If the parent is documented → delete the marker line (roxygen2 8.0.0 inherits the parent method’s @param into the subclass method).

If the parent is cross-package or the param is not documented there → replace with #' @param {param} (no documentation available) to preserve the zero-warning guarantee on rendered Rd.

Cross-package parents: markers are always replaced with the fallback text because we cannot inspect foreign packages’ wrapper content at write time.