boost_mirror/geometry
1
0
Fork 0
mirror of https://github.com/boostorg/geometry.git synced 2025-05-12 14:01:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

[geometry] fixed documentation: removed template parameters, made pythagoras back to a class, remove xml files in make_qbk to avoid using old ones

Browse Source 
[SVN r85412]
This commit is contained in:
Barend Gehrels 2013-08-20 20:22:33 +00:00
parent fa2c9e373b
commit 52db334352
6 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/doxy/Doxyfile
View File

@ -54,6 +54,7 @@ ALIASES = qbk{1}="\xmlonly <qbk>\1</qbk> \endxmlonly" \
tparam_box="Any type fulfilling a Box Concept" \ tparam_box="Any type fulfilling a Box Concept" \
tparam_box_or_segment="Any type fulfilling a Box Concept or a Segment Concept" \ tparam_box_or_segment="Any type fulfilling a Box Concept or a Segment Concept" \
tparam_calculation="numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point" \ tparam_calculation="numeric type for calculation (e.g. high precision); if [*void] then it is extracted automatically from the coordinate type and (if necessary) promoted to floating point" \
tparam_radius="numeric type for radius (of sphere, earth)" \
tparam_container="container type, for example std::vector, std::deque" \ tparam_container="container type, for example std::vector, std::deque" \
tparam_dimension_required="Dimension, this template parameter is required. Should contain \\[0 .. n-1\\] for an n-dimensional geometry" \ tparam_dimension_required="Dimension, this template parameter is required. Should contain \\[0 .. n-1\\] for an n-dimensional geometry" \
tparam_first_point="first point type" \ tparam_first_point="first point type" \

1
doc/make_qbk.py
View File

@ -36,6 +36,7 @@ cmd = cmd + " > generated/%s.qbk"
def call_doxygen(): def call_doxygen():
os.chdir("doxy"); os.chdir("doxy");
os.system("rm -f doxygen_output/xml/*.xml")
os.system(doxygen_cmd) os.system(doxygen_cmd)
os.chdir("..") os.chdir("..")

2
include/boost/geometry/strategies/cartesian/distance_projected_point.hpp
View File

@ -50,8 +50,6 @@ namespace strategy { namespace distance
\ingroup strategies \ingroup strategies
\details Calculates distance using projected-point method, and (optionally) Pythagoras \details Calculates distance using projected-point method, and (optionally) Pythagoras
\author Adapted from: http://geometryalgorithms.com/Archive/algorithm_0102/algorithm_0102.htm \author Adapted from: http://geometryalgorithms.com/Archive/algorithm_0102/algorithm_0102.htm
\tparam Point \tparam_point
\tparam PointOfSegment \tparam_segment_point
\tparam CalculationType \tparam_calculation \tparam CalculationType \tparam_calculation
\tparam Strategy underlying point-point distance strategy \tparam Strategy underlying point-point distance strategy
\par Concepts for Strategy: \par Concepts for Strategy:

6
include/boost/geometry/strategies/cartesian/distance_pythagoras.hpp
View File

@ -115,8 +115,6 @@ public :
/*! /*!
\brief Strategy to calculate the distance between two points \brief Strategy to calculate the distance between two points
\ingroup strategies \ingroup strategies
\tparam Point1 \tparam_first_point
\tparam Point2 \tparam_second_point
\tparam CalculationType \tparam_calculation \tparam CalculationType \tparam_calculation
\qbk{ \qbk{
@ -131,8 +129,10 @@ template
< <
typename CalculationType = void typename CalculationType = void
> >
struct pythagoras class pythagoras
{ {
public :
template <typename P1, typename P2> template <typename P1, typename P2>
struct calculation_type struct calculation_type
: util::calculation_type::geometric::binary : util::calculation_type::geometric::binary

2
include/boost/geometry/strategies/spherical/distance_cross_track.hpp
View File

@ -44,8 +44,6 @@ namespace strategy { namespace distance
\ingroup strategies \ingroup strategies
\details Class which calculates the distance of a point to a segment, using latlong points \details Class which calculates the distance of a point to a segment, using latlong points
\see http://williams.best.vwh.net/avform.htm \see http://williams.best.vwh.net/avform.htm
\tparam Point point type
\tparam PointOfSegment \tparam_segment_point
\tparam CalculationType \tparam_calculation \tparam CalculationType \tparam_calculation
\tparam Strategy underlying point-point distance strategy, defaults to haversine \tparam Strategy underlying point-point distance strategy, defaults to haversine

3
include/boost/geometry/strategies/spherical/distance_haversine.hpp
View File

@ -100,8 +100,7 @@ private :
\brief Distance calculation for spherical coordinates \brief Distance calculation for spherical coordinates
on a perfect sphere using haversine on a perfect sphere using haversine
\ingroup strategies \ingroup strategies
\tparam Point1 \tparam_first_point \tparam RadiusType \tparam_radius
\tparam Point2 \tparam_second_point
\tparam CalculationType \tparam_calculation \tparam CalculationType \tparam_calculation
\author Adapted from: http://williams.best.vwh.net/avform.htm \author Adapted from: http://williams.best.vwh.net/avform.htm
\see http://en.wikipedia.org/wiki/Great-circle_distance \see http://en.wikipedia.org/wiki/Great-circle_distance