songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

change \sa ::FOO into \s `FOO` 

using:
perl  -pi -e 's/\\sa\s+::([A-Za-z0-9_:]+)\s*/\\sa `$1`\n/'
This commit is contained in:
Sébastien Loriot 2012-11-23 09:18:35 +01:00
parent ac726ba6c2
commit 4fa2db4a48
38 changed files with 131 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h
View File

@ -8,9 +8,9 @@ with remainder.
\cgalRefines `AdaptableBinaryFunction` \cgalRefines `AdaptableBinaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
\sa ::AlgebraicStructureTraits::Mod \sa `AlgebraicStructureTraits::Mod`
\sa ::AlgebraicStructureTraits::DivMod \sa `AlgebraicStructureTraits::DivMod`
*/ */

6
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h
View File

@ -189,9 +189,9 @@ r
\cgalRefines `AdaptableFunctor` \cgalRefines `AdaptableFunctor`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
\sa ::AlgebraicStructureTraits::Mod \sa `AlgebraicStructureTraits::Mod`
\sa ::AlgebraicStructureTraits::Div \sa `AlgebraicStructureTraits::Div`
*/ */

4
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h
View File

@ -16,8 +16,8 @@ The second operator returns \f$ c\f$ via the additional third argument.
\cgalRefines `AdaptableBinaryFunction` \cgalRefines `AdaptableBinaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
\sa ::AlgebraicStructureTraits::IntegralDivision \sa `AlgebraicStructureTraits::IntegralDivision`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h
View File

@ -17,7 +17,7 @@ Thus, \f$ 0\f$ is divided by every element of the Ring, in particular by itself.
\cgalRefines `AdaptableBinaryFunction` \cgalRefines `AdaptableBinaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

4
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h
View File

@ -13,8 +13,8 @@ this operation is undefined. Since the ring represented is an integral domain,
\cgalRefines `AdaptableBinaryFunction` \cgalRefines `AdaptableBinaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
\sa ::AlgebraicStructureTraits::Divides \sa `AlgebraicStructureTraits::Divides`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h
View File

@ -8,7 +8,7 @@ respect to multiplication of a `Field`.
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h
View File

@ -8,7 +8,7 @@ returns true in case the argument is the one of the ring.
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h
View File

@ -13,7 +13,7 @@ that \f$ x= y*y\f$. In case the ring is a `UniqueFactorizationDomain`,
\cgalRefines `AdaptableBinaryFunction` \cgalRefines `AdaptableBinaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

4
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h
View File

@ -7,8 +7,8 @@
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
\sa ::RealEmbeddableTraits::IsZero \sa `RealEmbeddableTraits::IsZero`
*/ */

4
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h
View File

@ -7,8 +7,8 @@
\cgalRefines `AdaptableBinaryFunction` \cgalRefines `AdaptableBinaryFunction`
\sa ::FieldWithRootOf \sa `FieldWithRootOf`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

6
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h
View File

@ -7,9 +7,9 @@
\cgalRefines `AdaptableBinaryFunction` \cgalRefines `AdaptableBinaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
\sa ::AlgebraicStructureTraits::Div \sa `AlgebraicStructureTraits::Div`
\sa ::AlgebraicStructureTraits::DivMod \sa `AlgebraicStructureTraits::DivMod`
*/ */

4
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h
View File

@ -8,8 +8,8 @@ polynomial.
\cgalRefines `AdaptableFunctor` \cgalRefines `AdaptableFunctor`
\sa ::FieldWithRootOf \sa `FieldWithRootOf`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h
View File

@ -7,7 +7,7 @@ This `AdaptableUnaryFunction` may simplify a given object.
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h
View File

@ -7,7 +7,7 @@
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h
View File

@ -7,7 +7,7 @@
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h
View File

@ -21,7 +21,7 @@ associate being one. The unit part of zero is, by convention, one.
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

32
Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h
View File

@ -11,22 +11,22 @@ it contains various functors and descriptive tags.
Moreover it gives access to the several possible Moreover it gives access to the several possible
algebraic operations within that structure. algebraic operations within that structure.
\sa ::IntegralDomainWithoutDivision \sa `IntegralDomainWithoutDivision`
\sa ::IntegralDomain \sa `IntegralDomain`
\sa ::UniqueFactorizationDomain \sa `UniqueFactorizationDomain`
\sa ::EuclideanRing \sa `EuclideanRing`
\sa ::Field \sa `Field`
\sa ::FieldWithSqrt \sa `FieldWithSqrt`
\sa ::FieldWithKthRoot \sa `FieldWithKthRoot`
\sa ::FieldWithRootOf \sa `FieldWithRootOf`
\sa ::CGAL::Integral_domain_without_division_tag \sa `CGAL::Integral_domain_without_division_tag`
\sa ::CGAL::Integral_domain_tag \sa `CGAL::Integral_domain_tag`
\sa ::CGAL::Unique_factorization_domain_tag \sa `CGAL::Unique_factorization_domain_tag`
\sa ::CGAL::Euclidean_ring_tag \sa `CGAL::Euclidean_ring_tag`
\sa ::CGAL::Field_tag \sa `CGAL::Field_tag`
\sa ::CGAL::Field_with_sqrt_tag \sa `CGAL::Field_with_sqrt_tag`
\sa ::CGAL::Field_with_kth_root_tag \sa `CGAL::Field_with_kth_root_tag`
\sa ::CGAL::Field_with_root_of_tag \sa `CGAL::Field_with_root_of_tag`
\cgalHasModel `CGAL::Algebraic_structure_traits<T>` \cgalHasModel `CGAL::Algebraic_structure_traits<T>`

18
Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h
View File

@ -25,15 +25,15 @@ the smallest positive remainder \f$ r\f$.
\cgalRefines `UniqueFactorizationDomain` \cgalRefines `UniqueFactorizationDomain`
\sa ::IntegralDomainWithoutDivision \sa `IntegralDomainWithoutDivision`
\sa ::IntegralDomain \sa `IntegralDomain`
\sa ::UniqueFactorizationDomain \sa `UniqueFactorizationDomain`
\sa ::EuclideanRing \sa `EuclideanRing`
\sa ::Field \sa `Field`
\sa ::FieldWithSqrt \sa `FieldWithSqrt`
\sa ::FieldWithKthRoot \sa `FieldWithKthRoot`
\sa ::FieldWithRootOf \sa `FieldWithRootOf`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

18
Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h
View File

@ -19,15 +19,15 @@ Moreover, `CGAL::Algebraic_structure_traits< Field >` is a model of
\cgalRefines `IntegralDomain` \cgalRefines `IntegralDomain`
\sa ::IntegralDomainWithoutDivision \sa `IntegralDomainWithoutDivision`
\sa ::IntegralDomain \sa `IntegralDomain`
\sa ::UniqueFactorizationDomain \sa `UniqueFactorizationDomain`
\sa ::EuclideanRing \sa `EuclideanRing`
\sa ::Field \sa `Field`
\sa ::FieldWithSqrt \sa `FieldWithSqrt`
\sa ::FieldWithKthRoot \sa `FieldWithKthRoot`
\sa ::FieldWithRootOf \sa `FieldWithRootOf`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

18
Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithKthRoot.h
View File

@ -13,15 +13,15 @@ Moreover, `CGAL::Algebraic_structure_traits< FieldWithKthRoot >` is a model of `
\cgalRefines `FieldWithSqrt` \cgalRefines `FieldWithSqrt`
\sa ::IntegralDomainWithoutDivision \sa `IntegralDomainWithoutDivision`
\sa ::IntegralDomain \sa `IntegralDomain`
\sa ::UniqueFactorizationDomain \sa `UniqueFactorizationDomain`
\sa ::EuclideanRing \sa `EuclideanRing`
\sa ::Field \sa `Field`
\sa ::FieldWithSqrt \sa `FieldWithSqrt`
\sa ::FieldWithKthRoot \sa `FieldWithKthRoot`
\sa ::FieldWithRootOf \sa `FieldWithRootOf`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

18
Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithRootOf.h
View File

@ -13,15 +13,15 @@ Moreover, `CGAL::Algebraic_structure_traits< FieldWithRootOf >` is a model of `A
\cgalRefines `FieldWithKthRoot` \cgalRefines `FieldWithKthRoot`
\sa ::IntegralDomainWithoutDivision \sa `IntegralDomainWithoutDivision`
\sa ::IntegralDomain \sa `IntegralDomain`
\sa ::UniqueFactorizationDomain \sa `UniqueFactorizationDomain`
\sa ::EuclideanRing \sa `EuclideanRing`
\sa ::Field \sa `Field`
\sa ::FieldWithSqrt \sa `FieldWithSqrt`
\sa ::FieldWithKthRoot \sa `FieldWithKthRoot`
\sa ::FieldWithRootOf \sa `FieldWithRootOf`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

18
Algebraic_foundations/doc/Algebraic_foundations/Concepts/FieldWithSqrt.h
View File

@ -12,15 +12,15 @@ Moreover, `CGAL::Algebraic_structure_traits< FieldWithSqrt >` is a model of `Alg
\cgalRefines `Field` \cgalRefines `Field`
\sa ::IntegralDomainWithoutDivision \sa `IntegralDomainWithoutDivision`
\sa ::IntegralDomain \sa `IntegralDomain`
\sa ::UniqueFactorizationDomain \sa `UniqueFactorizationDomain`
\sa ::EuclideanRing \sa `EuclideanRing`
\sa ::Field \sa `Field`
\sa ::FieldWithSqrt \sa `FieldWithSqrt`
\sa ::FieldWithKthRoot \sa `FieldWithKthRoot`
\sa ::FieldWithRootOf \sa `FieldWithRootOf`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/Fraction.h
View File

@ -8,7 +8,7 @@ decompose it into a numerator and denominator. In this case the relevant
functionality for decomposing and re-composing as well as the numerator and functionality for decomposing and re-composing as well as the numerator and
denominator type are provided by `CGAL::Fraction_traits`. denominator type are provided by `CGAL::Fraction_traits`.
\sa ::FractionTraits \sa `FractionTraits`
\sa `CGAL::Fraction_traits<T>` \sa `CGAL::Fraction_traits<T>`
*/ */

18
Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomain.h
View File

@ -18,15 +18,15 @@ Moreover, `CGAL::Algebraic_structure_traits< IntegralDomain >` is a model of
\cgalRefines `IntegralDomainWithoutDivision` \cgalRefines `IntegralDomainWithoutDivision`
\sa ::IntegralDomainWithoutDivision \sa `IntegralDomainWithoutDivision`
\sa ::IntegralDomain \sa `IntegralDomain`
\sa ::UniqueFactorizationDomain \sa `UniqueFactorizationDomain`
\sa ::EuclideanRing \sa `EuclideanRing`
\sa ::Field \sa `Field`
\sa ::FieldWithSqrt \sa `FieldWithSqrt`
\sa ::FieldWithKthRoot \sa `FieldWithKthRoot`
\sa ::FieldWithRootOf \sa `FieldWithRootOf`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

18
Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h
View File

@ -36,15 +36,15 @@ Moreover, `CGAL::Algebraic_structure_traits< IntegralDomainWithoutDivision >` is
\cgalRefines `EqualityComparable` \cgalRefines `EqualityComparable`
\cgalRefines `FromIntConstructible` \cgalRefines `FromIntConstructible`
\sa ::IntegralDomainWithoutDivision \sa `IntegralDomainWithoutDivision`
\sa ::IntegralDomain \sa `IntegralDomain`
\sa ::UniqueFactorizationDomain \sa `UniqueFactorizationDomain`
\sa ::EuclideanRing \sa `EuclideanRing`
\sa ::Field \sa `Field`
\sa ::FieldWithSqrt \sa `FieldWithSqrt`
\sa ::FieldWithKthRoot \sa `FieldWithKthRoot`
\sa ::FieldWithRootOf \sa `FieldWithRootOf`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h
View File

@ -41,7 +41,7 @@ is a sub-ring of the real numbers and hence has characteristic zero.
\cgalRefines `Equality` Comparable \cgalRefines `Equality` Comparable
\cgalRefines `LessThanComparable` \cgalRefines `LessThanComparable`
\sa ::RealEmbeddableTraits \sa `RealEmbeddableTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h
View File

@ -7,7 +7,7 @@
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::RealEmbeddableTraits \sa `RealEmbeddableTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h
View File

@ -7,7 +7,7 @@
\cgalRefines `AdaptableBinaryFunction` \cgalRefines `AdaptableBinaryFunction`
\sa ::RealEmbeddableTraits \sa `RealEmbeddableTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h
View File

@ -7,7 +7,7 @@
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::RealEmbeddableTraits \sa `RealEmbeddableTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h
View File

@ -7,7 +7,7 @@
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::RealEmbeddableTraits \sa `RealEmbeddableTraits`
*/ */

4
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h
View File

@ -7,8 +7,8 @@
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::RealEmbeddableTraits \sa `RealEmbeddableTraits`
\sa ::AlgebraicStructureTraits::IsZero \sa `AlgebraicStructureTraits::IsZero`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h
View File

@ -7,7 +7,7 @@ This `AdaptableUnaryFunction` computes the sign of a real embeddable number.
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::RealEmbeddableTraits \sa `RealEmbeddableTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h
View File

@ -11,7 +11,7 @@ to methods that are specific to NT. There are no general guarantees whatsoever.
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::RealEmbeddableTraits \sa `RealEmbeddableTraits`
*/ */

2
Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h
View File

@ -9,7 +9,7 @@ This interval is represented by `std::pair<double,double>`.
\cgalRefines `AdaptableUnaryFunction` \cgalRefines `AdaptableUnaryFunction`
\sa ::RealEmbeddableTraits \sa `RealEmbeddableTraits`
*/ */

18
Algebraic_foundations/doc/Algebraic_foundations/Concepts/UniqueFactorizationDomain.h
View File

@ -25,15 +25,15 @@ derived from `CGAL::Unique_factorization_domain_tag`
\cgalRefines `IntegralDomain` \cgalRefines `IntegralDomain`
\sa ::IntegralDomainWithoutDivision \sa `IntegralDomainWithoutDivision`
\sa ::IntegralDomain \sa `IntegralDomain`
\sa ::UniqueFactorizationDomain \sa `UniqueFactorizationDomain`
\sa ::EuclideanRing \sa `EuclideanRing`
\sa ::Field \sa `Field`
\sa ::FieldWithSqrt \sa `FieldWithSqrt`
\sa ::FieldWithKthRoot \sa `FieldWithKthRoot`
\sa ::FieldWithRootOf \sa `FieldWithRootOf`
\sa ::AlgebraicStructureTraits \sa `AlgebraicStructureTraits`
*/ */

2
Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h
View File

@ -16,7 +16,7 @@ methods to coordinates `x()`, `y()`, `z()` are needed.
\cgalHasModel `CGAL::Cartesian<FieldNumberType>` \cgalHasModel `CGAL::Cartesian<FieldNumberType>`
\cgalHasModel `CGAL::Simple_cartesian<FieldNumberType>` \cgalHasModel `CGAL::Simple_cartesian<FieldNumberType>`
\sa ::LocalKernel \sa `LocalKernel`
*/ */

4
Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h
View File

@ -32,8 +32,8 @@ vector types.
\cgalHasModel `CGAL::Cartesian<FieldNumberType>` \cgalHasModel `CGAL::Cartesian<FieldNumberType>`
\cgalHasModel `CGAL::Simple_cartesian<FieldNumberType>` \cgalHasModel `CGAL::Simple_cartesian<FieldNumberType>`
\sa ::DataKernel \sa `DataKernel`
\sa ::SvdTraits \sa `SvdTraits`
*/ */

4
Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Translate.h
View File

@ -14,8 +14,8 @@ the polynomial is considered as a univariate polynomial in one specific variable
\cgalRefines `CopyConstructible` \cgalRefines `CopyConstructible`
\cgalRefines `DefaultConstructible` \cgalRefines `DefaultConstructible`
\sa ::Polynomial_d \sa `Polynomial_d`
\sa ::PolynomialTraits_d \sa `PolynomialTraits_d`
*/ */