Skip to main content

param_documented

Function param_documented 

Source
pub(crate) fn param_documented(tags: &[String], name: &str) -> bool
Expand description

Returns true if name is documented by any @param tag in tags.

A tag documents name if name is exactly one of the comma-separated names in its @param <names> <desc> name token (see extract_param_names). This is an exact-membership check, not a prefix match — starts_with(&format!("@param {name}")) was the previous (buggy) approach: it misses every name after the first in a comma-list tag (@param a,b,c desc “documents” only a, so b/c get a spurious (no documentation available) filler that roxygen2 then merges into a duplicate \item{b} and \item{c} in the rendered Rd — an R CMD check checking Rd \usage sections WARNING), and it also false-positives on names that are prefixes of other names (@param x2 desc looks like it documents x too).