docs: clean-up of C docstrings

Planeshifter · Planeshifter · commit 911e1793885a · 2025-02-09T17:44:43.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/cauchy/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/cauchy/entropy/src/main.c
@@ -26,7 +26,7 @@
 *
 * @param x0       location parameter
 * @param gamma    scale parameter
-* @return         evaluated entropy
+* @return         entropy
 *
 * @example
 * double y = stdlib_base_dists_cauchy_entropy( 10.0, 5.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/mode/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/cauchy/mode/src/main.c
@@ -24,7 +24,7 @@
 *
 * @param x0       location parameter
 * @param gamma    scale parameter
-* @return         evaluated mode
+* @return         mode
 *
 * @example
 * double y = stdlib_base_dists_cauchy_mode( 10.0, 5.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/chi/mode/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/chi/mode/src/main.c
@@ -24,7 +24,7 @@
 * Returns the mode of a chi distribution.
 *
 * @param k    degrees of freedom
-* @return     evaluated mode
+* @return     mode
 *
 * @example
 * double y = stdlib_base_dists_chi_mode( 9.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/chisquare/entropy/src/main.c
@@ -26,7 +26,7 @@
 * Returns the differential entropy of a chi-squared distribution.
 *
 * @param k    degrees of freedom
-* @return     evaluated entropy
+* @return     entropy
 *
 * @example
 * double y = stdlib_base_dists_chisquare_entropy( 9.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/mode/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/chisquare/mode/src/main.c
@@ -24,7 +24,7 @@
 * Returns the mode of a chi-squared distribution.
 *
 * @param k    degrees of freedom
-* @return     evaluated mode
+* @return     mode
 *
 * @example
 * double y = stdlib_base_dists_chisquare_mode( 9.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/skewness/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/chisquare/skewness/src/main.c
@@ -24,7 +24,7 @@
 * Returns the skewness of a chi-squared distribution.
 *
 * @param k    degrees of freedom
-* @return     evaluated skewness
+* @return     skewness
 *
 * @example
 * double y = stdlib_base_dists_chisquare_skewness( 9.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/variance/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/degenerate/variance/src/main.c
@@ -26,7 +26,7 @@
 * @return      variance
 *
 * @example
-* double y = stdlib_base_degenerate_variance( 0.1 );
+* double y = stdlib_base_dists_degenerate_variance( 0.1 );
 * // returns 0.0
 */
 double stdlib_base_dists_degenerate_variance( const double mu ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/f/entropy/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/f/entropy/src/main.c
@@ -27,7 +27,7 @@
 *
 * @param d1    numerator degrees of freedom
 * @param d2    denominator degrees of freedom
-* @return      evaluated entropy
+* @return      entropy
 *
 * @example
 * double y = stdlib_base_dists_f_entropy( 3.0, 7.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/f/kurtosis/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/f/kurtosis/src/main.c
@@ -24,7 +24,7 @@
 *
 * @param d1    numerator degrees of freedom
 * @param d2    denominator degrees of freedom
-* @return      evaluated kurtosis
+* @return      excess kurtosis
 *
 * @example
 * double y = stdlib_base_dists_f_kurtosis( 3.0, 9.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/f/mode/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/f/mode/src/main.c
@@ -23,7 +23,7 @@
 *
 * @param a    numerator degrees of freedom
 * @param b    denominator degrees of freedom
-* @return     evaluated mode
+* @return     mode
 *
 * @example
 * double y = stdlib_base_dists_f_mode( 3.0, 5.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/f/skewness/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/f/skewness/src/main.c
@@ -24,7 +24,7 @@
 *
 * @param a    numerator degrees of freedom
 * @param b    denominator degrees of freedom
-* @return     evaluated skewness
+* @return     skewness
 *
 * @example
 * double y = stdlib_base_dists_f_skewness( 3.0, 7.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/f/variance/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/f/variance/src/main.c
@@ -24,7 +24,7 @@
 *
 * @param d1    numerator degrees of freedom
 * @param d2    denominator degrees of freedom
-* @return      evaluated variance
+* @return      variance
 *
 * @example
 * double y = stdlib_base_dists_f_variance( 3.0, 5.0 );
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
@@ -29,7 +29,7 @@
 * @return         entropy
 *
 * @example
-* double y = stdlib_base_invgamma_entropy( 1.0, 1.0 );
+* double y = stdlib_base_dists_invgamma_entropy( 1.0, 1.0 );
 * // returns ~2.154
 */
 double stdlib_base_dists_invgamma_entropy( const double alpha, const double beta ) {
diff --git a/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/median/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/median/src/main.c
@@ -25,7 +25,7 @@
 *
 * @param a       first shape parameter
 * @param b       second shape parameter
-* @return        evaluated median
+* @return        median
 *
 * @example
 * double y = stdlib_base_dists_kumaraswamy_median( 2.0, 3.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/normal/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/normal/stdev/src/main.c
@@ -22,9 +22,9 @@
 /**
 * Returns the standard deviation for a normal distribution with mean `mu` and standard deviation `sigma`.
 *
-* @param mu     mean of the distribution
-* @param sigma  standard deviation of the distribution
-* @return       standard deviation of the normal distribution
+* @param mu     mean
+* @param sigma  standard deviation
+* @return       standard deviation
 *
 * @example
 * double y = stdlib_base_dists_normal_stdev( 0.0, 1.0 );
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
@@ -26,7 +26,7 @@
 * Returns the differential entropy of a Rayleigh distribution.
 *
 * @param sigma    scale parameter
-* @return         evaluated entropy
+* @return         entropy
 *
 * @example
 * double y = stdlib_base_dists_rayleigh_entropy( 9.0 );

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`*`
`27`	`27`	`* @param x0 location parameter`
`28`	`28`	`* @param gamma scale parameter`
`29`		`-* @return evaluated entropy`
	`29`	`+* @return entropy`
`30`	`30`	`*`
`31`	`31`	`* @example`
`32`	`32`	`* double y = stdlib_base_dists_cauchy_entropy( 10.0, 5.0 );`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`*`
`25`	`25`	`* @param x0 location parameter`
`26`	`26`	`* @param gamma scale parameter`
`27`		`-* @return evaluated mode`
	`27`	`+* @return mode`
`28`	`28`	`*`
`29`	`29`	`* @example`
`30`	`30`	`* double y = stdlib_base_dists_cauchy_mode( 10.0, 5.0 );`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`*`
`28`	`28`	`* @param d1 numerator degrees of freedom`
`29`	`29`	`* @param d2 denominator degrees of freedom`
`30`		`-* @return evaluated entropy`
	`30`	`+* @return entropy`
`31`	`31`	`*`
`32`	`32`	`* @example`
`33`	`33`	`* double y = stdlib_base_dists_f_entropy( 3.0, 7.0 );`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`*`
`24`	`24`	`* @param a numerator degrees of freedom`
`25`	`25`	`* @param b denominator degrees of freedom`
`26`		`-* @return evaluated mode`
	`26`	`+* @return mode`
`27`	`27`	`*`
`28`	`28`	`* @example`
`29`	`29`	`* double y = stdlib_base_dists_f_mode( 3.0, 5.0 );`