docs: clean-up of C docstrings

Planeshifter · Planeshifter · commit b9a2014b1181 · 2025-02-09T16:39:58.000-05:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: passed
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: na
  - task: run_cpp_examples
    status: na
  - task: run_javascript_readme_examples
    status: na
  - task: run_c_benchmarks
    status: na
  - task: run_cpp_benchmarks
    status: na
  - task: run_fortran_benchmarks
    status: na
  - task: run_javascript_benchmarks
    status: na
  - task: run_julia_benchmarks
    status: na
  - task: run_python_benchmarks
    status: na
  - task: run_r_benchmarks
    status: na
  - task: run_javascript_tests
    status: na
---
diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/arcsine/mean/src/main.c
@@ -27,7 +27,7 @@
 * @return     expected value
 *
 * @example
-* double v = mean( 0.0, 1.0 );
+* double v = stdlib_base_dists_arcsine_mean( 0.0, 1.0 );
 * // returns 0.5
 */
 double stdlib_base_dists_arcsine_mean( const double a, const double b ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/pdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/arcsine/pdf/src/main.c
@@ -30,7 +30,7 @@
 * @return     evaluated PDF
 *
 * @example
-* double y = stdlib_base_arcsine_pdf( 2.0, 0.0, 4.0 );
+* double y = stdlib_base_dists_arcsine_pdf( 2.0, 0.0, 4.0 );
 * // returns ~0.159
 */
 double stdlib_base_dists_arcsine_pdf( const double x, const double a, const double b ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/bernoulli/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/bernoulli/stdev/src/main.c
@@ -27,7 +27,7 @@
 * @return     standard deviation
 *
 * @example
-* double y = stdlib_base_bernoulli_stdev( 0.1 );
+* double y = stdlib_base_dists_bernoulli_stdev( 0.1 );
 * // returns ~0.3
 */
 double stdlib_base_dists_bernoulli_stdev( const double p ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/beta/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/beta/mean/src/main.c
@@ -26,7 +26,7 @@
 * @return         evaluated value
 *
 * @example
-* double y = stdlib_base_beta_mean( 1.0, 1.0 );
+* double y = stdlib_base_dists_beta_mean( 1.0, 1.0 );
 * // returns 0.5
 */
 double stdlib_base_dists_beta_mean( const double alpha, const double beta ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/beta/mode/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/beta/mode/src/main.c
@@ -26,7 +26,7 @@
 * @return         mode
 *
 * @example
-* double y = stdlib_base_beta_mode( 4.0, 12.0 );
+* double y = stdlib_base_dists_beta_mode( 4.0, 12.0 );
 * // returns ~0.214
 */
 double stdlib_base_dists_beta_mode( const double alpha, const double beta ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/beta/skewness/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/beta/skewness/src/main.c
@@ -27,7 +27,7 @@
 * @return         skewness
 *
 * @example
-* double y = stdlib_base_beta_skewness( 1.0, 1.0 );
+* double y = stdlib_base_dists_beta_skewness( 1.0, 1.0 );
 * // returns 0.0
 */
 double stdlib_base_dists_beta_skewness( const double alpha, const double beta ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/kurtosis/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/kurtosis/src/main.c
@@ -23,7 +23,7 @@
 * Returns the excess kurtosis of a beta prime distribution.
 *
 * @param alpha    first shape parameter
-* @param beta     second shape paramter
+* @param beta     second shape parameter
 * @return         excess kurtosis
 *
 * @example
diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/skewness/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/skewness/src/main.c
@@ -24,8 +24,8 @@
 * Returns the skewness of a beta prime distribution.
 *
 * @param alpha    first shape parameter
-* @param beta     second shape paramter
-* @return         stdandard deviation
+* @param beta     second shape parameter
+* @return         standard deviation
 *
 * @example
 * double y = stdlib_base_betaprime_skewness( 2.0, 4.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/stdev/src/main.c
@@ -24,8 +24,8 @@
 * Returns the standard deviation of a beta prime distribution.
 *
 * @param alpha    first shape parameter
-* @param beta     second shape paramter
-* @return         stdandard deviation
+* @param beta     second shape parameter
+* @return         standard deviation
 *
 * @example
 * double y = stdlib_base_betaprime_stdev( 1.0, 3.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/betaprime/variance/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/betaprime/variance/src/main.c
@@ -23,7 +23,7 @@
 * Returns the variance of a beta prime distribution.
 *
 * @param alpha    first shape parameter
-* @param beta     second shape paramter
+* @param beta     second shape parameter
 * @return         variance
 *
 * @example
diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/kurtosis/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/exponential/kurtosis/src/main.c
@@ -26,7 +26,7 @@
 * @return          excess kurtosis
 *
 * @example
-* double y = stdlib_base_exponential_kurtosis( 9.0 );
+* double y = stdlib_base_dists_exponential_kurtosis( 9.0 );
 * // returns 6.0
 */
 double stdlib_base_dists_exponential_kurtosis( const double lambda ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/kurtosis/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/gamma/kurtosis/src/main.c
@@ -27,7 +27,7 @@
 * @return         excess kurtosis
 *
 * @example
-* double y = stdlib_base_gamma_kurtosis( 1.0, 1.0 );
+* double y = stdlib_base_dists_gamma_kurtosis( 1.0, 1.0 );
 * // returns 6.0
 */
 double stdlib_base_dists_gamma_kurtosis( const double alpha, const double beta ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/mean/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/gamma/mean/src/main.c
@@ -26,7 +26,7 @@
 * @return         expected value
 *
 * @example
-* double y = stdlib_base_gamma_mean( 1.0, 1.0 );
+* double y = stdlib_base_dists_gamma_mean( 1.0, 1.0 );
 * // returns 1.0
 */
 double stdlib_base_dists_gamma_mean( const double alpha, const double beta ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/invgamma/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/invgamma/entropy/src/main.c
@@ -25,7 +25,7 @@
 * Returns the differential entropy of an inverse gamma distribution.
 *
 * @param alpha    shape parameter
-* @param beta     rate paramter
+* @param beta     rate parameter
 * @return         entropy
 *
 * @example
diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/entropy/src/main.c
@@ -25,7 +25,7 @@
 * Returns the differential entropy of a Laplace distribution.
 *
 * @param mu    location parameter
-* @param b     scale paramter
+* @param b     scale parameter
 * @return      entropy
 *
 * @example
diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/skewness/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/skewness/src/main.c
@@ -24,7 +24,7 @@
 * Returns the skewness of a Pareto (Type I) distribution.
 *
 * @param alpha    first shape parameter
-* @param beta     second shape paramter
+* @param beta     second shape parameter
 * @return         skewness
 *
 * @example
diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/stdev/src/main.c
@@ -26,8 +26,8 @@
 * Returns the standard deviation of a Pareto (Type I) distribution.
 *
 * @param alpha    first shape parameter
-* @param beta     second shape paramter
-* @return         stdandard deviation
+* @param beta     second shape parameter
+* @return         standard deviation
 *
 * @example
 * double y = stdlib_base_dists_pareto_type1_stdev( 4.0, 12.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/cdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/cdf/src/main.c
@@ -29,7 +29,7 @@
 * @return         evaluated CDF
 *
 * @example
-* double y = stdlib_base_arcsine_cdf( 2.0, 3.0 );
+* double y = stdlib_base_dists_rayleigh_cdf( 2.0, 3.0 );
 * // returns ~0.199
 */
 double stdlib_base_dists_rayleigh_cdf( const double x, const double sigma ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/entropy/src/main.c
@@ -29,7 +29,7 @@
 * @return         evaluated entropy
 *
 * @example
-* double y = stdlib_base_arcsine_entropy( 9.0 );
+* double y = stdlib_base_dists_rayleigh_entropy( 9.0 );
 * // returns ~3.139
 */
 double stdlib_base_dists_rayleigh_entropy( const double sigma ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/pdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/pdf/src/main.c
@@ -30,7 +30,7 @@
 * @return         evaluated PDF
 *
 * @example
-* double y = stdlib_base_rayleigh_cdf( 3.0, 1.0 );
+* double y = stdlib_base_dists_rayleigh_pdf( 3.0, 1.0 );
 * // returns ~0.287
 */
 double stdlib_base_dists_rayleigh_pdf( const double x, const double sigma ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/src/main.c
@@ -32,7 +32,7 @@
 * @return    evaluated logPDF
 *
 * @example
-* double y = stdlib_base_dists_geometric_logpdf( 0.5, -1.0, 1.0, 0.0 );
+* double y = stdlib_base_dists_triangular_logpdf( 0.5, -1.0, 1.0, 0.0 );
 * // returns ~-0.693
 */
 double stdlib_base_dists_triangular_logpdf( const double x, const double a, const double b, const double c ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/kurtosis/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/kurtosis/src/main.c
@@ -27,7 +27,7 @@
 * @return    excess kurtosis
 *
 * @example
-* double v = kurtosis( 4.0, 12.0 );
+* double v = stdlib_base_dists_uniform_kurtosis( 4.0, 12.0 );
 * // returns -1.2
 */
 double stdlib_base_dists_uniform_kurtosis( const double a, const double b ) {

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`* @return expected value`
`28`	`28`	`*`
`29`	`29`	`* @example`
`30`		`-* double v = mean( 0.0, 1.0 );`
	`30`	`+* double v = stdlib_base_dists_arcsine_mean( 0.0, 1.0 );`
`31`	`31`	`* // returns 0.5`
`32`	`32`	`*/`
`33`	`33`	`double stdlib_base_dists_arcsine_mean( const double a, const double b ) {`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`* @return evaluated PDF`
`31`	`31`	`*`
`32`	`32`	`* @example`
`33`		`-* double y = stdlib_base_arcsine_pdf( 2.0, 0.0, 4.0 );`
	`33`	`+* double y = stdlib_base_dists_arcsine_pdf( 2.0, 0.0, 4.0 );`
`34`	`34`	`* // returns ~0.159`
`35`	`35`	`*/`
`36`	`36`	`double stdlib_base_dists_arcsine_pdf( const double x, const double a, const double b ) {`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`* @return evaluated value`
`27`	`27`	`*`
`28`	`28`	`* @example`
`29`		`-* double y = stdlib_base_beta_mean( 1.0, 1.0 );`
	`29`	`+* double y = stdlib_base_dists_beta_mean( 1.0, 1.0 );`
`30`	`30`	`* // returns 0.5`
`31`	`31`	`*/`
`32`	`32`	`double stdlib_base_dists_beta_mean( const double alpha, const double beta ) {`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`* Returns the excess kurtosis of a beta prime distribution.`
`24`	`24`	`*`
`25`	`25`	`* @param alpha first shape parameter`
`26`		`-* @param beta second shape paramter`
	`26`	`+* @param beta second shape parameter`
`27`	`27`	`* @return excess kurtosis`
`28`	`28`	`*`
`29`	`29`	`* @example`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,8 @@`
`24`	`24`	`* Returns the skewness of a beta prime distribution.`
`25`	`25`	`*`
`26`	`26`	`* @param alpha first shape parameter`
`27`		`-* @param beta second shape paramter`
`28`		`-* @return stdandard deviation`
	`27`	`+* @param beta second shape parameter`
	`28`	`+* @return standard deviation`
`29`	`29`	`*`
`30`	`30`	`* @example`
`31`	`31`	`* double y = stdlib_base_betaprime_skewness( 2.0, 4.0 );`