diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt index fb5b5a95a07..903dcb16903 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt @@ -1739,7 +1739,7 @@ expected to either coincide with an existing vertex or lie inside a face. It is possible to invoke one of the specialized insertion functions (see Section \ref aos_ssec-basic-arr_class), based on the query results, and insert \f$c\f$ at its proper -location.\cgalFootnote{The `CGAL::insert_non_intersecting_curve<>()` +location.\cgalFootnote{The \cgalFootnoteCode{CGAL::insert_non_intersecting_curve<>()} function template, as all other functions reviewed in this section, is parameterized by an arrangement type and a point-location type (The latter must be substituted with a model of the @@ -1832,7 +1832,7 @@ consider vertical line-segments to be weakly \f$x\f$-monotone). Consider an arrangement of circles. A circle is obviously not \f$x\f$-monotone, so `CGAL::insert<>()` cannot be used in this -case.\cgalFootnote{A key operation performed by `CGAL::insert<>()` is +case.\cgalFootnote{A key operation performed by \cgalFootnoteCode{CGAL::insert<>()} is to locate the left endpoint of the curve in the arrangement. A circle, however, does not have any endpoints!} , it is necessary to subdivide each circle into two \f$x\f$-monotone circular arcs, namely, its upper @@ -4142,7 +4142,7 @@ class template and the `Arr_segment_traits_2` class template are both parameterized by a geometric kernel and model the concepts `ArrangementTraits_2` and `ArrangementLandmarkTraits_2`. \cgalFootnote{They also model the refined concept -`ArrangementDirectionalXMonotoneTraits_2`, which enables Boolean set +\cgalFootnoteCode{ArrangementDirectionalXMonotoneTraits_2}, which enables Boolean set operations; see Package \ref PkgBooleanSetOperations2Ref.} The class template `Arr_non_caching_segment_traits_2` derives from the instance `Arr_non_caching_segment_basic_traits_2`, which @@ -4940,9 +4940,9 @@ template parameter is defined as the `Coefficient` type. This type cannot be algebraic. Moreover, it is recommended that this type is not made rational either, since using rational (as opposed to integral) coefficients does not extend the range of the rational arcs and is -typically less efficient.\cgalFootnote{The `Algebraic_kernel_d_1` +typically less efficient.\cgalFootnote{The \cgalFootnoteCode{Algebraic_kernel_d_1} class template uses the types provided by the \ref PkgPolynomial -package to define its nested `Polynomial_1` type and conveniently +package to define its nested \cgalFootnoteCode{Polynomial_1} type and conveniently expose it to the user.} The `Bound` type, however, can be algebraic. A point of type \link Arr_rational_function_traits_2::Point_2 `Point_2`\endlink nested in the `Arr_rational_function_traits_2` class @@ -6749,7 +6749,7 @@ and defines a simple textual input/output format. \boost\cgalFootnote{See also \boost's homepage at: -www.boost.org.} is a collection of portable \cpp libraries +\cgalFootnoteCode{www.boost.org}.} is a collection of portable \cpp libraries that extend the \cpp Standard Library. The \boost Graph Library (\bgl), which one of the libraries in the collection, offers an extensive set of generic graph algorithms parameterized through diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h index 1424516ba10..7d004c99ff3 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h @@ -32,7 +32,7 @@ * `ArrangementOpenBoundaryTraits_2` must have all the four categories * convertible to `CGAL::Arr_open_side_tag`.\cgalFootnote{We intend to introduce * more concepts that require only a subset of the categories to be convertible - * to `CGAL::Arr_open_side_tag`.} In this case the \dcel of the arrangement + * to \cgalFootnoteCode{CGAL::Arr_open_side_tag}.} In this case the \dcel of the arrangement * instantiated with the model is initialized with an implicit bounding * rectangle. When the parameter space is bounded, it is the exact geometric * embedding of the implicit bounding rectangle. diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt index cd2aed0b5da..a60f1e33f1e 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Boolean_set_operations_2.txt @@ -168,7 +168,7 @@ Section \ref bso_secbso_gen. The basic components of our package are the free (global) functions `complement()` that accepts a single `Polygon_2` object, and -`intersection()`, `join()`,\cgalFootnote{The function that computes the union of two polygons is called `join()`, since the word `union` is reserved in \cpp.} `difference()`, +`intersection()`, `join()`,\cgalFootnote{The function that computes the union of two polygons is called \cgalFootnoteCode{join()}, since the word \cgalFootnoteCode{union} is reserved in \cpp.} `difference()`, `symmetric_difference()` and the predicate `do_intersect()` that accept two `Polygon_2` objects as their input. We explain how these functions should be used through several examples in the @@ -702,7 +702,7 @@ The traits classes `Arr_segment_traits_2`, `Arr_conic_traits_2` and `Arr_rational_function_traits_2`, which are bundled in the `Arrangement_2` package and distributed with \cgal, are all models of the refined concept -`ArrangementDirectionalXMonotoneTraits_2`.\cgalFootnote{The `Arr_polyline_traits_2` class is not a model of the, `ArrangementDirectionalXMonotoneTraits_2` concept, as the \f$ x\f$-monotone curve it defines is always directed from left to right. Thus, an opposite curve cannot be constructed. However, it is not very useful to construct a polygon whose edges are polylines, as an ordinary polygon with linear edges can represent the same entity.} +`ArrangementDirectionalXMonotoneTraits_2`.\cgalFootnote{The \cgalFootnoteCode{Arr_polyline_traits_2} class is not a model of the, \cgalFootnoteCode{ArrangementDirectionalXMonotoneTraits_2} concept, as the \f$ x\f$-monotone curve it defines is always directed from left to right. Thus, an opposite curve cannot be constructed. However, it is not very useful to construct a polygon whose edges are polylines, as an ordinary polygon with linear edges can represent the same entity.} Just as with the case of computations using models of the `ArrangementXMonotoneTraits_2` concept, operations are robust only diff --git a/Documentation/doc/Customizations.txt b/Documentation/doc/Customizations.txt index 7523551114f..c1debd91db6 100644 --- a/Documentation/doc/Customizations.txt +++ b/Documentation/doc/Customizations.txt @@ -29,7 +29,7 @@ TDS_2, which don't reside in their own packages in the SCM. ### Footnotes ### A JQuery footnotes plug-in jquery.footnotes is used to handle -footnotes. The special doxygen command \cgalFootnote expands to the +footnotes. The special doxygen command `\cgalFootnote` expands to the appropriate html marker. Some JavaScript in `header.html` is used to append the `
    ` to the current doc-content div. It is not added to the footer because this would break when tree diff --git a/Documentation/doc/Documentation/Developer_manual/Chapter_code_format.txt b/Documentation/doc/Documentation/Developer_manual/Chapter_code_format.txt index fe80c80344f..0bf547b6a1c 100644 --- a/Documentation/doc/Documentation/Developer_manual/Chapter_code_format.txt +++ b/Documentation/doc/Documentation/Developer_manual/Chapter_code_format.txt @@ -243,13 +243,13 @@ The first list of items are meant as rules, i.e., you should follow them. modify the object to which it is applied, e.g., `class A { int f( void) const; };`. This should also be done when it is only conceptually `const`. - This means that the member function `f()` is `c`onst as seen from + This means that the member function `f()` is `const` as seen from the outside, but internally it may modify some data members - that are declared `m`utable. An example + that are declared `mutable`. An example is the caching of results from expensive computations. For more information about conceptually `c`onst functions and mutable data members see \cgalCite{cgal:m-ec-97}. -- Prefer \cpp-style to C-style casts, e.g., use `static_cast( i)` instead of `(`double)i. +- Prefer \cpp-style to C-style casts, e.g., use `static_cast( i)` instead of `(double)i`. - Protect header files against multiple inclusion, e.g. the file This_is_an_example.h should begin/end with \code{.cpp} #ifndef CGAL_THIS_IS_AN_EXAMPLE_H diff --git a/Documentation/doc/Documentation/Developer_manual/Chapter_iterators_and_circulators.txt b/Documentation/doc/Documentation/Developer_manual/Chapter_iterators_and_circulators.txt index c6419e59f24..b7450d5cd3d 100644 --- a/Documentation/doc/Documentation/Developer_manual/Chapter_iterators_and_circulators.txt +++ b/Documentation/doc/Documentation/Developer_manual/Chapter_iterators_and_circulators.txt @@ -86,9 +86,9 @@ struct iterator_traits { \section secinput_and_output_iterators Input and output iterators -Operator * for input and output iterators +Operator `*` for input and output iterators -The operator * of input and output iterators has a restricted semantics. +The operator `*` of input and output iterators has a restricted semantics. Input iterators are designed for input operations, and it is not required that the value type `T` of an input iterator `it` be assignable. diff --git a/Documentation/doc/Documentation/Developer_manual/Chapter_kernels.txt b/Documentation/doc/Documentation/Developer_manual/Chapter_kernels.txt index fe3f13bd291..30b56687143 100644 --- a/Documentation/doc/Documentation/Developer_manual/Chapter_kernels.txt +++ b/Documentation/doc/Documentation/Developer_manual/Chapter_kernels.txt @@ -11,7 +11,7 @@ basic geometric entities of constant size\cgalFootnote{In dimension \f$ d\f$, an primitive operations on them. Each entity is provided as both a stand-alone class, which is parameterized by a kernel class, and as a type in the kernel class. Each operation in the kernel is provided via -a functor class\cgalFootnote{A class which defines a member `operator()`.} in the kernel +a functor class\cgalFootnote{A class which defines a member \cgalFootnoteCode{operator()}.} in the kernel class and also as either a member function or a global function. See \cgalCite{hhkps-aegk-01} for more details about this design. Ideally, if the kernel provides all the primitives required, you can diff --git a/Documentation/doc/Documentation/Developer_manual/Chapter_multithreading.txt b/Documentation/doc/Documentation/Developer_manual/Chapter_multithreading.txt index 6c122a5dbf3..f3137a64de5 100644 --- a/Documentation/doc/Documentation/Developer_manual/Chapter_multithreading.txt +++ b/Documentation/doc/Documentation/Developer_manual/Chapter_multithreading.txt @@ -7,7 +7,7 @@ \section Developer_manualThreadlocal Thread Local Storage -The header file provides a macro `CGAL_STATIC_THREAD_LOCAL_VARIABLE(TYPE,VAR,ARG1)` +The header file `` provides a macro `CGAL_STATIC_THREAD_LOCAL_VARIABLE(TYPE,VAR,ARG1)` that creates a thread local variable `VAR` of type `TYPE`, and passes `ARG1` to the constructor. The variable is either `threadlocal`, or a `boost::thread_specific_ptr`, or just a local variable if `CGAL_HAS_THREADS` is not defined. @@ -15,6 +15,6 @@ or just a local variable if `CGAL_HAS_THREADS` is not defined. \section Developer_manualMutex Mutex -The header file provides a macro `CGAL_MUTEX` and a macro `CGAL_SCOPED_LOCK(M)` that is either a `std::unique_lock` or a `boost::mutex::scoped_lock`. +The header file `` provides a macro `CGAL_MUTEX` and a macro `CGAL_SCOPED_LOCK(M)` that is either a `std::unique_lock` or a `boost::mutex::scoped_lock`. */ diff --git a/Documentation/doc/Documentation/Developer_manual/Chapter_namespaces.txt b/Documentation/doc/Documentation/Developer_manual/Chapter_namespaces.txt index 12476b61223..17f8a076b34 100644 --- a/Documentation/doc/Documentation/Developer_manual/Chapter_namespaces.txt +++ b/Documentation/doc/Documentation/Developer_manual/Chapter_namespaces.txt @@ -14,7 +14,7 @@ and FLTK adds `fl`. \leda uses prefix `leda_` to some extent, but you have to tell \leda not to make the corresponding unprefixed names -available as well.\cgalFootnote{\cgal's makefile does this by setting `-DLEDA_PREFIX`.} Initially, \cgal used +available as well.\cgalFootnote{\cgal's makefile does this by setting \cgalFootnoteCode{-DLEDA_PREFIX}.} Initially, \cgal used prefix `CGAL_`. At the beginning of 1999, it was decided to drop prefix `CGAL_` and to introduce namespace `CGAL`. diff --git a/Documentation/doc/Documentation/Developer_manual/Chapter_objects.txt b/Documentation/doc/Documentation/Developer_manual/Chapter_objects.txt index 5899626ee8d..2dd3ab4ff72 100644 --- a/Documentation/doc/Documentation/Developer_manual/Chapter_objects.txt +++ b/Documentation/doc/Documentation/Developer_manual/Chapter_objects.txt @@ -25,9 +25,9 @@ UML class diagram for faked object hierarchies (since 2.2-I-4). Functions having a polymorphic return type create an object of the actual result type and wrap it into an object of type `Object`. -Refer to the documentation of `#CGAL::Object` class for more details. +Refer to the documentation of `CGAL::Object` class for more details. -An alternative is to use a class handling several output iterators at the same time such as the classes `#CGAL::Dispatch_output_iterator`. -and `#CGAL::Dispatch_or_drop_output_iterator`. +An alternative is to use a class handling several output iterators at the same time such as the classes `CGAL::Dispatch_output_iterator`. +and `CGAL::Dispatch_or_drop_output_iterator`. */ diff --git a/Documentation/doc/Documentation/Developer_manual/Chapter_portability.txt b/Documentation/doc/Documentation/Developer_manual/Chapter_portability.txt index 56c4dc59b3b..c1c6482ca91 100644 --- a/Documentation/doc/Documentation/Developer_manual/Chapter_portability.txt +++ b/Documentation/doc/Documentation/Developer_manual/Chapter_portability.txt @@ -219,19 +219,19 @@ where os-compiler refers to a string describing your operating system and compiler that is defined as follows.
    - \f$ <\f$arch\f$ >\f$_\f$ <\f$os\f$ >\f$-\f$ <\f$os-version\f$ >\f$_\f$ <\f$comp\f$ >\f$-\f$ <\f$comp-version\f$ >\f$ + `_-_-`
    -
    \f$ <\f$arch\f$ >\f$
    is the system architecture as defined by uname -p or uname -m, -
    \f$ <\f$os\f$ >\f$
    is the operating system as defined by uname +
    ``
    is the system architecture as defined by uname -p or uname -m, +
    ``
    is the operating system as defined by uname -s, -
    \f$ <\f$os-version\f$ >\f$
    is the operating system version as defined by - "uname -r", -
    \f$ <\f$comp\f$ >\f$
    is the basename of the compiler executable (if it +
    ``
    is the operating system version as defined by + uname -r, +
    ``
    is the basename of the compiler executable (if it contains spaces, these are replaced by "-"), and -
    \f$ <\f$comp-version\f$ >\f$
    is the compiler's version number (which +
    ``
    is the compiler's version number (which unfortunately can not be derived in a uniform manner, since it is quite compiler specific).
    @@ -251,12 +251,12 @@ These test programs reside in the directory where $(CGAL_ROOT) represents the installation directory for the library. The names of all testfiles, which correspond to the names of the flags, -start with "CGAL_CFG_" followed by +start with CGAL_CFG_ followed by
    • either a description of a bug ending with - "_BUG" + _BUG
    • or a description of a feature starting with - "NO_". + NO_.
    For any of these files a corresponding flag is set in the platform-specific configuration file, iff either compilation or execution @@ -304,7 +304,7 @@ up-to-date version of this list. \subsection secworkaround_macros Macros connected to workarounds/compilers Some macros are defined according to certain workaround flags. This is -done to avoid some \#`ifdef`s in our actual code. +done to avoid some `#ifdef`s in our actual code.
    CGAL_LITTLE_ENDIAN
    set, iff diff --git a/Documentation/doc/Documentation/Developer_manual/Chapter_testing.txt b/Documentation/doc/Documentation/Developer_manual/Chapter_testing.txt index d5b6d53c988..627d452e1b8 100644 --- a/Documentation/doc/Documentation/Developer_manual/Chapter_testing.txt +++ b/Documentation/doc/Documentation/Developer_manual/Chapter_testing.txt @@ -16,7 +16,7 @@ Here is what you need: - define the environment variable `CGAL_DIR`. It should be the directory where you built CGAL. - optional: define the environment variables for Boost, GMP, and any optional third party lib, e.g. Eigen. - On Windows: define the environment variable `MAKE_CMD` (put the line `export MAKE_CMD=nmake` in your `$HOME/.bashrc` for VC++) -- On Windows: define the environment variable `CMAKE_GENERATOR` (put the line `export CMAKE_GENERATOR='-GNMake Makefiles'` in your `$HOME/.bashrc` for VC++) +- On Windows: define the environment variable `CMAKE_GENERATOR` (put the line export CMAKE_GENERATOR='-GNMake Makefiles' in your `$HOME/.bashrc` for VC++) - go in the directory you want to test - Run `cgal_test_with_cmake` in the `test` and `examples` directories of the package. This should run CMake, compile and run, and you can see what happened in the generated file `error.txt`. diff --git a/Documentation/doc/Documentation/Developer_manual/Chapter_traits_classes.txt b/Documentation/doc/Documentation/Developer_manual/Chapter_traits_classes.txt index a62a6ec97d2..92b7f4569bc 100644 --- a/Documentation/doc/Documentation/Developer_manual/Chapter_traits_classes.txt +++ b/Documentation/doc/Documentation/Developer_manual/Chapter_traits_classes.txt @@ -84,7 +84,7 @@ scope of the traits class in order for the algorithm to work. As you can guess, `Left_turn_2` is responsible for the orientation test, while `Less_xy_2` does the sorting. So, obviously, the traits class must provide these three identifiers. The requirements it has to satisfy -beyond that are documented in full with the concept ConvexHullTraits_2. +beyond that are documented in full with the concept `ConvexHullTraits_2`. \subsection subsectraits_class_requirements Traits class requirements @@ -92,7 +92,7 @@ Whenever you write a function or class that is parameterized with a traits class, you must provide the requirements that class has to fulfill. These requirements should be documented as a concept. For the example above, if you look in the manual at the description of the concept -`#ConvexHullTraits_2`, you will find that the +`ConvexHullTraits_2`, you will find that the traits class itself and the identifiers that are mentioned have to meet the following specifications: @@ -157,7 +157,7 @@ to the default traits class, and the last function parameter defaults to a default instance of the default traits class. Of course, such behavior must be specified in the \ref CGAL::ch_graham_andrew() "description of the function". -The implication is that a user can call `ch_graham_andrews` with +The implication is that a user can call `ch_graham_andrew` with just three parameters, which delimit the iterator range to be handled and supply the iterator for the result. The types and primitives used by the algorithm in this case are the ones from the \cgal 2D and 3D kernel. diff --git a/Documentation/doc/Documentation/Third_party.txt b/Documentation/doc/Documentation/Third_party.txt index 78b175de6c3..6e25f350ae0 100644 --- a/Documentation/doc/Documentation/Third_party.txt +++ b/Documentation/doc/Documentation/Third_party.txt @@ -11,11 +11,11 @@ supporting C++14 or later. | Operating System | Compiler | | :---------- | :--------------- | -| Linux | \gnu `g++` 10.2.1 or later\cgalFootnote{`http://gcc.gnu.org/`} | -| | `Clang` \cgalFootnote{`http://clang.llvm.org/`} compiler version 13.0.0 | -| \ms Windows | \gnu `g++` 10.2.1 or later\cgalFootnote{`http://gcc.gnu.org/`} | -| | \ms Visual `C++` 14.0, 15.9, 16.10, 17.0 (\visualstudio 2015, 2017, 2019, and 2022)\cgalFootnote{`https://visualstudio.microsoft.com/`} | -| MacOS X | \gnu `g++` 10.2.1 or later\cgalFootnote{`http://gcc.gnu.org/`} | +| Linux | \gnu `g++` 10.2.1 or later\cgalFootnote{\cgalFootnoteCode{http://gcc.gnu.org/}} | +| | `Clang` \cgalFootnote{\cgalFootnoteCode{http://clang.llvm.org/}} compiler version 13.0.0 | +| \ms Windows | \gnu `g++` 10.2.1 or later\cgalFootnote{\cgalFootnoteCode{http://gcc.gnu.org/}} | +| | \ms Visual `C++` 14.0, 15.9, 16.10, 17.0 (\visualstudio 2015, 2017, 2019, and 2022)\cgalFootnote{\cgalFootnoteCode{https://visualstudio.microsoft.com/}} | +| MacOS X | \gnu `g++` 10.2.1 or later\cgalFootnote{\cgalFootnoteCode{http://gcc.gnu.org/}} | | | Apple `Clang` compiler versions 10.0.1, 12.0.5, and 13.0.0 | diff --git a/Documentation/doc/Documentation/advanced/Configuration_variables.txt b/Documentation/doc/Documentation/advanced/Configuration_variables.txt index 2d7299bd36d..f989032bbae 100644 --- a/Documentation/doc/Documentation/advanced/Configuration_variables.txt +++ b/Documentation/doc/Documentation/advanced/Configuration_variables.txt @@ -130,7 +130,7 @@ For example, you can add the path to the \boost `.dll` to the | Variable | Description | Type | | :- | :- | :- | -| `BOOST_ROOT`\cgalFootnote{The environment variable can be spelled either `BOOST_ROOT` or `BOOSTROOT`} | Root directory of your \boost installation | Either CMake or Environment | +| `BOOST_ROOT`\cgalFootnote{The environment variable can be spelled either \cgalFootnoteCode{BOOST_ROOT} or \cgalFootnoteCode{BOOSTROOT}} | Root directory of your \boost installation | Either CMake or Environment | | `Boost_INCLUDE_DIR` | Directory containing the `boost/version.hpp` file | CMake | | `BOOST_INCLUDEDIR` | Idem | Environment | | `Boost_LIBRARY_DIRS` | Directory containing the compiled \boost libraries | CMake | diff --git a/Documentation/doc/resources/1.9.3/BaseDoxyfile.in b/Documentation/doc/resources/1.9.3/BaseDoxyfile.in index a12bfce4648..198e1a224d7 100644 --- a/Documentation/doc/resources/1.9.3/BaseDoxyfile.in +++ b/Documentation/doc/resources/1.9.3/BaseDoxyfile.in @@ -354,6 +354,7 @@ ALIASES = "cgal=%CGAL" \ "cgalModifEnd=\htmlonly \endhtmlonly \latexonly END MODIFICATIONS \endlatexonly" \ "cgalPkgBib{1}=BibTeX: \1-${CGAL_RELEASE_YEAR_ID}
    " \ "cgalFootnote{1}=\1" \ + "cgalFootnoteCode{1}=\1" \ "cgalAutoToc=\htmlonly[block]
    \endhtmlonly" \ "cgalTagTrue=\link CGAL::Tag_true `CGAL::Tag_true`\endlink" \ "cgalTagFalse=\link CGAL::Tag_false `CGAL::Tag_false`\endlink" \ diff --git a/Documentation/doc/resources/1.9.3/stylesheet.css b/Documentation/doc/resources/1.9.3/stylesheet.css index f640966e203..52cc5ad12ef 100644 --- a/Documentation/doc/resources/1.9.3/stylesheet.css +++ b/Documentation/doc/resources/1.9.3/stylesheet.css @@ -107,6 +107,10 @@ span.legend { text-align: center; } +span.obfuscator { + display: none; +} + h3.version { font-size: 90%; text-align: center; diff --git a/Kernel_23/doc/Kernel_23/Kernel_23.txt b/Kernel_23/doc/Kernel_23/Kernel_23.txt index 3680f47268d..51eeea986db 100644 --- a/Kernel_23/doc/Kernel_23/Kernel_23.txt +++ b/Kernel_23/doc/Kernel_23/Kernel_23.txt @@ -353,7 +353,7 @@ assert( p == q ); In order to obtain the point corresponding to a vector \f$ v\f$ you simply have to add \f$ v\f$ to \ref ORIGIN. If you want to determine -the point \f$ q\f$ in the middle between two points \f$ p_1\f$ and \f$ p_2\f$, you can write\cgalFootnote{you might call `midpoint(p_1,p_2)` instead.} +the point \f$ q\f$ in the middle between two points \f$ p_1\f$ and \f$ p_2\f$, you can write\cgalFootnote{you might call \cgalFootnoteCode{midpoint(p_1,p_2)} instead.} \code{.cpp} q = p_1 + (p_2 - p_1) / 2.0; diff --git a/Kernel_d/doc/Kernel_d/Kernel_d.txt b/Kernel_d/doc/Kernel_d/Kernel_d.txt index 30c46dbc277..fcfbfe0afec 100644 --- a/Kernel_d/doc/Kernel_d/Kernel_d.txt +++ b/Kernel_d/doc/Kernel_d/Kernel_d.txt @@ -349,7 +349,7 @@ assert( p == q ); In order to obtain the point corresponding to a vector \f$ v\f$ you simply have to add \f$ v\f$ to `ORIGIN`. If you want to determine the point \f$ q\f$ in the middle between two points \f$ p_1\f$ and \f$ p_2\f$, you can -write\cgalFootnote{you might call `midpoint(p_1,p_2)` instead} +write\cgalFootnote{you might call \cgalFootnoteCode{midpoint(p_1,p_2)} instead} \code{.cpp} q = p_1 + (p_2 - p_1) / 2.0; diff --git a/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h b/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h index 8cd7eab7f2d..8d3572e3f0e 100644 --- a/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h +++ b/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h @@ -297,7 +297,7 @@ is a pair of vertices `(v,w)` with incidence operations `v = source(e)`, `w = ta `v` is called the adjacency list `A(v)`. Edges are paired into twins. For each edge `e = (v,w)` there's an -edge `twin(e) = (w,v)` and `twin(twin(e)) == e`\cgalFootnote{The existence of the edge pairs makes `P` a bidirected graph, the `twin` links make `P` a map.}. +edge `twin(e) = (w,v)` and `twin(twin(e)) == e`\cgalFootnote{The existence of the edge pairs makes \cgalFootnoteCode{P} a bidirected graph, the \cgalFootnoteCode{twin} links make \cgalFootnoteCode{P} a map.}. An edge `e = (v,w)` knows two adjacent edges `en = next(e)` and `ep = previous(e)` where `source(en) = w`, diff --git a/Number_types/doc/Number_types/CGAL/Sqrt_extension.h b/Number_types/doc/Number_types/CGAL/Sqrt_extension.h index 039787b29aa..dcde8e1163c 100644 --- a/Number_types/doc/Number_types/CGAL/Sqrt_extension.h +++ b/Number_types/doc/Number_types/CGAL/Sqrt_extension.h @@ -13,7 +13,7 @@ An instance of this class represents an extension of the type `NT` by *one* squa For example, let `Integer` be some type representing \f$ \Z\f$, then `Sqrt_extension` is able to represent \f$ \Z[\sqrt{\mathrm{root}}]\f$ -for some arbitrary Integer \f$\mathrm{root}\f$. \cgalFootnote{\f$ R[a]\f$ denotes the extension of a ring \f$ R\f$ by an element \f$ a\f$. See also: http://mathworld.wolfram.com/ExtensionRing.html} +for some arbitrary Integer \f$\mathrm{root}\f$. \cgalFootnote{\f$ R[a]\f$ denotes the extension of a ring \f$ R\f$ by an element \f$ a\f$. See also: \cgalFootnoteCode{http://mathworld.wolfram.com/ExtensionRing.html}} The value of \f$\mathrm{root}\f$ is set at construction time, or set to zero if it is not specified. diff --git a/Number_types/doc/Number_types/NumberTypeSupport.txt b/Number_types/doc/Number_types/NumberTypeSupport.txt index 38ec6150b45..2a2e35866ae 100644 --- a/Number_types/doc/Number_types/NumberTypeSupport.txt +++ b/Number_types/doc/Number_types/NumberTypeSupport.txt @@ -23,7 +23,7 @@ structure concepts see Section \ref PkgAlgebraicFoundationsRef. The built-in number types `float`, `double` and `long double` have the required arithmetic and comparison operators. They lack some required routines though which are automatically included by \cgal. -\cgalFootnote{The functions can be found in the header files CGAL/int.h, CGAL/float.h, CGAL/double.h and CGAL/long_long.h.} +\cgalFootnote{The functions can be found in the header files \cgalFootnoteCode{CGAL/int.h}, \cgalFootnoteCode{CGAL/float.h}, \cgalFootnoteCode{CGAL/double.h} and \cgalFootnoteCode{CGAL/long_long.h}.} All built-in number types of \cpp can represent a discrete (bounded) subset of the rational numbers only. We assume that the diff --git a/Polynomial/doc/Polynomial/Polynomial.txt b/Polynomial/doc/Polynomial/Polynomial.txt index b94ff218e1e..4334a430771 100644 --- a/Polynomial/doc/Polynomial/Polynomial.txt +++ b/Polynomial/doc/Polynomial/Polynomial.txt @@ -236,7 +236,7 @@ structure of the innermost coefficient, for instance, a gcd is available if and only if the innermost coefficient is a `Field` or a `UniqueFactorizationDomain`. Hence, we can not provide a \f$ gcd\f$ if the innermost coefficient is just an `IntegralDomain` since it is simply -not well defined\cgalFootnote{An example for such a number type is the template `Sqrt_extension` representing an algebraic extension of degree two. This is just an `IntegralDomain` if NT is not a `Field`. }. +not well defined\cgalFootnote{An example for such a number type is the template S\cgalFootnoteCode{qrt_extension} representing an algebraic extension of degree two. This is just an \cgalFootnoteCode{IntegralDomain} if NT is not a `Field`. }. However, if we would consider the polynomial over the quotient field of the integral domain the \f$ gcd\f$ would be well defined. The only problem is that the result can not be represented over the ring since it contains diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h index d5700a0df3f..b6f268ea048 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h @@ -6,8 +6,8 @@ namespace CGAL { \brief computes all furthest neighbors for the vertices of the convex polygon described by the range [`points_begin`, `points_end`), writes their indices (relative to `points_begin`) to `o`\cgalFootnote{the -furthest neighbor of `points_begin[i]` is `points_begin[i-th number -written to o]`} and returns the past-the-end iterator of this +furthest neighbor of \cgalFootnoteCode{points_begin[i]} is \cgalFootnoteCode{points_begin[i-th number +written to o]}} and returns the past-the-end iterator of this sequence. The function `all_furthest_neighbors_2()` computes all furthest