minor doc fixes

skramm · Apr 20, 2024 · 6b8ff15 · 6b8ff15
1 parent e544de2
commit 6b8ff15
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -41,16 +41,14 @@ int main()
 ```
 
 ### News ###
+
+- 2024-04-21: switch to c++17, enable runtime polymorphism using `std::variant`, [see here](docs/homog2d_manual.md#section_rtp)
 - 2024-03-23: added SVG "path" element import
 - 2023-12-26: fresh 2.11 release, see https://github.com/skramm/homog2d/releases
 - 2023-11-17: added [doc index](docs/index.md)
 - 2023-07-11: added online Doxygen-generated reference, through the great https://codedocs.xyz/ [see here](https://codedocs.xyz/skramm/homog2d)
 - 2023-02-19: 2.10 release, see https://github.com/skramm/homog2d/releases
 - 2023-02-12: added support for "big numbers" through the [ttmath](https://www.ttmath.org/) library, [see here](docs/homog2d_manual.md#bignum)) (preliminar!)
-- 2022-12-17: moved CI tests from Travis to GH actions
-- 2022-12-05: re-enabled clang compiler in test suite
-- 2022-11-23: 2.9 release
-- 2022-09-23: passed the 1000 unit tests threshold (with `$ make test -j4 USE_TINYXML2=Y USE_OPENCV=Y`)
 
 (see [history](docs/homog2d_history.md) for more)
 

diff --git a/docs/homog2d_devinfo.md b/docs/homog2d_devinfo.md
@@ -17,6 +17,12 @@ To get the "full" reference, run:
 $ make doc-dev
 ```
 
+**2024/04/21**: A move to C++17 has been done.
+This will greatly simplify the code, by enabling auto return types and replacing lots of SFINAE stuctures by `constexpr if`.
+It also enables run-time polymorphism without pointers, with the help of `std::variant`
+[details here](homog2d_manual.md#section_rtp).
+
+
 ## 2 - Git branches
 
 `master` branch is supposed to stay stable, with all tests passing.

diff --git a/docs/homog2d_history.md b/docs/homog2d_history.md
@@ -14,10 +14,6 @@ See [Release page](https://github.com/skramm/homog2d/releases).
   - add some feature to be able to print coordinates with desired precision at runtime
   - add `Vector` type (defined by dx,dy)
 
-**2020/04**: A move to C++17 is currently underways.
-This will greatly simplify the code, by enabling auto return types and replacing lots of SFINAE stuctures by `constexpr if`.
-It will also enable run-time polymorphism without pointers, with the help of `std::variant`.
-
 - current Work In Progress
   - polygon minimization
 
@@ -26,6 +22,7 @@ It will also enable run-time polymorphism without pointers, with the help of `st
 This was possible by moving to C++17.
   - removed requirement to pointer-based runtime polymorphism to import SVG file, by using `std::variant`.
   - generalization of bounding box of pair of objects
+  - SVG import: added reading of image size in file
   - added SVG import of `path` element, [see manual](homog2d_manual.md#svg_import_example)
   - bugfixes:
     - https://github.com/skramm/homog2d/issues/11

diff --git a/docs/homog2d_manual.md b/docs/homog2d_manual.md
@@ -2148,7 +2148,8 @@ It is enabled only if symbol `HOMOG2D_ENABLE_RTP` is defined
 
 ### 10.3 - Technical details on svg file import
 
-You can fetch the size of image in the SVG file (as `double`):
+You can fetch the size of image in the SVG file (as `double`) with `getImgSize()`.
+However, this will throw if no size can be found, so you might consider using that in a "try/catch":
 ```C++
 std::pair<double,double> imSize(500.,500.); // default size
 try

diff --git a/docs/index.csv b/docs/index.csv
@@ -19,8 +19,8 @@ Thresholds;thresholds;
 Drawing parameters;manual;drawing_params
 Lines and Points;manual;basic
 Build options;manual;build_options
-Regular Convex Polygon;manual;set_RCP
-RCP;manual;set_RCP
+Regular Convex Polygon (RCP);manual;set_RCP
+Runtime polymorphism;manual;section_rtp
 ttmath library;manual;bignum
 Boost Geometry library;manual;boost_geom_1
 Opencv;manual;drawing

diff --git a/docs/index.md b/docs/index.md
@@ -15,14 +15,14 @@
 * [Polygon Extremum points](homog2d_manual.md#poly_extremum_points)
 * [Polygon](homog2d_manual.md#p_polyline)
 * [Polygon Rotation/mirroring](homog2d_manual.md#polyline_rotate)
-* [RCP](homog2d_manual.md#set_RCP)
 * [Rectangle](homog2d_manual.md#p_frect)
-* [Regular Convex Polygon](homog2d_manual.md#set_RCP)
+* [Regular Convex Polygon (RCP)](homog2d_manual.md#set_RCP)
+* [Runtime polymorphism](homog2d_manual.md#section_rtp)
 * [Segment](homog2d_manual.md#p_segment)
 * [Showcase](homog2d_showcase.md#)
 * [SVG drawing](homog2d_manual.md#drawing)
 * [SVG import](homog2d_manual.md#svg_import)
 * [Thresholds](homog2d_thresholds.md#)
 * [ttmath library](homog2d_manual.md#bignum)
 <hr>
-Page generated on 2023-12-15
+Page generated on 2024-04-21