stillwater-sc / universal / 37803630275
86%
master: 84%

LAST BUILD BRANCH: docs/decimals-of-accuracy
DEFAULT BRANCH: master
Ran
Jobs 1
Files 693
Run time 3min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 86.289% (-0.02%) from 86.305%
37803630275

push

github

web-flow 
docs: clear the Doxygen warnings and drop archived posits from the index (#1645)

* docs: remove the archived posit1 and posito from the number-systems index

Both types are archived. The index still listed them as current (legacy
v1, experimental), and their links did not resolve on the docs site.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs: clear the Doxygen warnings in the API reference build

Fixes all 78 distinct warnings from the Documentation workflow on main.

Doxyfile
- INPUT no longer lists include/sw/blas and include/sw/numeric, which do
  not exist.
- verification/ is excluded. It is the regression-test harness, not
  library API. Its per-type suites (test_suite_arithmetic, posit_, areal_
  and others) define functions with the same name and parameters that
  differ only in template parameters. Doxygen merges these into one
  entry, which produced the "multiple @param documentation sections"
  warnings and showed one suite's docs for all of them.

Dead code
- native/clang_long_double_config.hpp is removed. Nothing includes it.
  It could not compile: it reads a nonexistent decoder.bits, closes a
  namespace it never opens, and ends with a stray #endif. The live
  long_double_decoder is in ieee754_decoder.hpp.

Comments (no code changes)
- @param and <param> names now match the signatures:
  - polyeval(coefficients) in four horners.hpp
  - assign(str) in bfloat16, cfloat, dbns and lns
  - to_binary(bits), S_increment(val) and S_decrement(val)
  - setnan(NaNType)
  - systemEvaluator and ReportNumberSystemClosureStats
- Stale parameters removed:
  - blocktriple add/mul 'result'
  - GenerateTable 'uncertainty'
  - the verification 'tag' parameters
- Missing parameters documented:
  - round(exponent) in areal and cfloat
  - MinMaxLogNormalization(maxpos, minpos)
- <returns> removed from ten void functions.
- evaluate_closure_of_number_systems: malformed <param> name=, <template>
  and <return> tags rewritten as <param name=... (continued)

47124 of 54612 relevant lines covered (86.29%)

9991680.91 hits per line

Coverage Regressions

Lines Coverage ∆ File
9
95.35
-0.58% include/sw/universal/number/cfloat/cfloat_impl.hpp
Jobs
ID Job ID Ran Files Coverage
1 37803630275.1 693
86.29
GitHub Action Run
Source Files on build 37803630275