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

fix doc bug

This commit is contained in:
Sébastien Loriot 2016-01-13 11:03:41 +01:00
parent 1fc7e45cde
commit d29de1bc4d
1 changed files with 9 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Documentation/doc/Documentation/Developer_manual/Chapter_kernels.txt
View File

@ -119,30 +119,18 @@ homogeneous version of a predicate from the Cartesian version.
When adding a new function object to the kernel you must: When adding a new function object to the kernel you must:
<ul> <ul>
<li> possibly change include/CGAL/Kernel/function_objects.h <li> possibly change `include/CGAL/Kernel/function_objects.h`
to add a new function object "builder" in namespace internal:: to add a new function object <i>builder</i> in namespace `internal::`
<li> change include/CGAL/Kernel/interface_macros.h <li> change `include/CGAL/Kernel/interface_macros.h`
to add the actual function object class and its corresponding to add the actual function object class and its corresponding
member function that returns an object of this class member function that returns an object of this class
<li> change test/Kernel/include/CGAL/_test_new_2.h and/or <li> change `test/Kernel/include/CGAL/_test_new_2.h` and/or
test/Kernel/include/CGAL/_test_new_3.h to add the test `test/Kernel/include/CGAL/_test_new_3.h` to add the test
for this function object. for this function object.
<li> in the directory doc_tex/kernel/Ref add a file called <li> update `Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h`
Kernel_<NewFunctionObject> that describes the requirements for <li> add `New_function_object` to the set of requirements for the Kernel
this function object type (see the other similarly named files in this concept in the file `Kernel_23/doc/Kernel_23/Concepts/Kernel.h`
directory) <li> update the classified reference manual in `Kernel_23/doc/Kernel_23/PackageDescription.txt`
<ul>
<li> This functor should have a SeeAlso entry for the global function(s)
or class(es) that provide the same functionality in the imperative
interface
</ul>
<li> add <New_function_object> to the set of requirements for the Kernel
concept in the file doc_tex/kernel/Ref/Kernel.tex.
<li> in the file doc_tex/kernel/Ref/ref_manual.tex add the command
\input{Ref/Kernel_<New function object>}
in the proper place
<li> in the file doc_tex/kernel/kernel_toc add a ccRefConceptPage command
for the page in the proper place.
</ul> </ul>
*/ */