boostorg / geometry / 26695
93%

DEFAULT BRANCH: develop
Ran
Jobs 1
Files 784
Run time 1min
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: 93.189%. Remained the same
26695

push

circleci

web-flow 
[doc] Fix \tparam names that do not match the declaration (#1486)

* [doc] Document the actual template parameters of the projections

Every projection class in srs/projections/proj is
`template <typename T, typename Parameters>`, but the Doxygen block above
each one still documents `Geographic` and `Cartesian`, the parameters
these classes took before ddce41f2 (Apr 2017) moved the internal
representations. `T` has been undocumented since.

All 152 blocks in 99 headers were byte-identical and every one is
followed by `template <typename T, typename Parameters>`, so this is a
straight replacement. The wording for `T` is taken from
srs/projections/impl/base_dynamic.hpp, which already documents the same
type as "calculation type".

Comments only.

* [doc] Fix \tparam names that do not match the declaration

- clip_linestring.hpp: the Liang-Barsky strategy documents \tparam B and
  \tparam P, the template takes Box and Point.
- simplify.hpp: douglas_peucker_point writes '\tparam the enclosed point
  type', so Doxygen reads 'the' as the parameter name. It is Point.
- azimuth.hpp: default_strategy documents CalculationType, the template
  has only CSTag.
- transform.hpp: the four lines read '\tparam CoordinateSystemTag 1,2
  coordinate system tags', meaning both at once, so Doxygen sees a name
  that does not exist. Split into the eight real parameters. Source and
  target follow from transform(Geometry1 const&, Geometry2&), where the
  second one is the mutable output.

Comments only.

* [doc] Address review: ob_tran_static's StaticParameters, tmerc comment order

The \tparam list for ob_tran_static named T and Parameters but not
StaticParameters, which the declaration takes first. Added it in
declaration order.

In tmerc.hpp the doxygen block for tmerc_ellipsoid was separated from the
declaration by a commented-out copy of the approximate implementation, so
doxygen bound the comment to nothing. Moved the commented-out copy below
the real declaration. Noth... (continued)

33139 of 35561 relevant lines covered (93.19%)

1534992.8 hits per line

Coverage Regressions

Lines Coverage ∆ File
3
58.9
 0.0% boost/geometry/srs/projections/proj/ob_tran.hpp
3
78.32
 0.0% boost/geometry/srs/projections/proj/stere.hpp
Jobs
ID Job ID Ran Files Coverage
1 26695.1 784
93.19
Source Files on build 26695