cameracalibrate: Improve gst-inspect documentation

Thanks to @kazz_naka on Twitter

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-bad/-/merge_requests/1691>

diff --git a/docs/plugins/gst_plugins_cache.json b/docs/plugins/gst_plugins_cache.json
index c848461..75ae26a 100644 (file)
--- a/docs/plugins/gst_plugins_cache.json
+++ b/docs/plugins/gst_plugins_cache.json
@@ -211143,7 +211143,7 @@
         "elements": {
             "cameracalibrate": {
                 "author": "Philippe Renon <philippe_renon@yahoo.fr>",
-                "description": "Performs camera calibration",
+                "description": "Performs camera calibration by having it point at a chessboard pattern using upstream/downstream cameraundistort",
                 "hierarchy": [
                     "GstCameraCalibrate",
                     "GstOpencvVideoFilter",
@@ -211184,7 +211184,7 @@
                         "writable": true
                     },
                     "board-height": {
-                        "blurb": "The board height in number of items",
+                        "blurb": "The board height in number of items (e.g. number of squares for chessboard)",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
@@ -211198,7 +211198,7 @@
                         "writable": true
                     },
                     "board-width": {
-                        "blurb": "The board width in number of items",
+                        "blurb": "The board width in number of items (e.g. number of squares for chessboard)",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,

diff --git a/ext/opencv/gstcameracalibrate.cpp b/ext/opencv/gstcameracalibrate.cpp
index 16f8e30..291f6c7 100644 (file)
--- a/ext/opencv/gstcameracalibrate.cpp
+++ b/ext/opencv/gstcameracalibrate.cpp
@@ -204,13 +204,13 @@ gst_camera_calibrate_class_init (GstCameraCalibrateClass * klass)
 
   g_object_class_install_property (gobject_class, PROP_BOARD_WIDTH,
       g_param_spec_int ("board-width", "Board Width",
-          "The board width in number of items",
+          "The board width in number of items (e.g. number of squares for chessboard)",
           1, G_MAXINT, DEFAULT_BOARD_WIDTH,
           (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
 
   g_object_class_install_property (gobject_class, PROP_BOARD_HEIGHT,
       g_param_spec_int ("board-height", "Board Height",
-          "The board height in number of items",
+          "The board height in number of items (e.g. number of squares for chessboard)",
           1, G_MAXINT, DEFAULT_BOARD_WIDTH,
           (GParamFlags) (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)));
 
@@ -276,7 +276,8 @@ gst_camera_calibrate_class_init (GstCameraCalibrateClass * klass)
   gst_element_class_set_static_metadata (element_class,
       "cameracalibrate",
       "Filter/Effect/Video",
-      "Performs camera calibration",
+      "Performs camera calibration by having it point at a chessboard pattern "
+      "using upstream/downstream cameraundistort",
       "Philippe Renon <philippe_renon@yahoo.fr>");
 
   /* add sink and source pad templates */