% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/documentation_metrics.R
\name{assess_exported_functions_docs}
\alias{assess_exported_functions_docs}
\title{Assess documentation coverage for exported functions}
\usage{
assess_exported_functions_docs(pkg_name, pkg_source_path)
}
\arguments{
\item{pkg_name}{Character scalar; package name (must be loadable so exports can be read).}

\item{pkg_source_path}{Directory path where Rd files can be found by `tools::Rd_db()`.}
}
\value{
A list with:
\describe{
  \item{data}{A `data.frame` with columns:
    \describe{
      \item{function_name}{Exported function name.}
      \item{documentation_name}{The Rd topic name (`\\name{}`), or `"No documentation found"`.}
      \item{documentation_location}{`man/<file>.Rd` if found, otherwise `NA_character_`.}
    }
  }
  \item{documentation_score}{Numeric; percentage of exported functions with an Rd page.}
}
}
\description{
Resolves each **exported function** in a package to its Rd page and reports:
the function name, the Rd topic name (roxygen `@rdname`), and the Rd location.
Resolution uses the same alias/topic index as `assess_examples()`, so it
correctly handles functions documented under a shared topic (via `@rdname`)
and multiple `\\alias{}` entries (e.g., `stringr::str_to_upper` under
`man/case.Rd`).
}
\keyword{internal}
