Cleanup

Author: twistedfall

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,12 +4,12 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
-Before reporting an issue please first check the
-[troubleshooting guide](https://github.com/twistedfall/opencv-rust/blob/master/README.md#troubleshooting). If
-the issue you're encountering is not solved thereby please state the following in your bugreport:
+Before reporting an issue, please first check
+the [troubleshooting guide](https://github.com/twistedfall/opencv-rust/blob/master/TROUBLESHOOTING.md). If the issue you're
+encountering is not solved thereby please state the following in your bugreport:
+
 1. Operating system
 2. The way you installed OpenCV: package, official binary distribution, manual compilation, etc.
 3. OpenCV version

Cargo.toml

@@ -4,14 +4,15 @@ description = "Rust bindings for OpenCV"
 documentation = "https://docs.rs/opencv"
 repository = "https://github.com/twistedfall/opencv-rust"
 readme = "README.md"
-keywords = ["opencv", "vision"]
+keywords = ["opencv", "vision", "cv"]
+categories = ["api-bindings", "computer-vision", "external-ffi-bindings", "multimedia"]
 license = "MIT"
 version = "0.95.1"
 # bump edition to 2024 when MSRV is 1.85
 edition = "2021"
 rust-version = "1.77.0"
 authors = ["Pro <[email protected]>", "Mathieu Poumeyrol <[email protected]>"]
-exclude = ["/.github", "/ci", "/tools", ".editorconfig", ".gitattributes", ".gitignore", "release.toml", "rustfmt.toml"]
+exclude = ["/.github", "/ci", "/tools", "/.editorconfig", "/.gitattributes", "/release.toml", "/rustfmt.toml", ".gitignore"]
 
 [lib]
 doctest = false

TROUBLESHOOTING.md

@@ -1,9 +1,9 @@
 ## Troubleshooting
 
-1. One of the common problems is link errors in the end of the build.
+1. One of the common problems is link errors at the end of the build.
 
    Be sure to set up the relevant environment variables that will allow the linker to find the libraries it
-   needs (see below).
+   needs (see [Environment variables](https://github.com/twistedfall/opencv-rust/blob/master/README.md#environment-variables)).
 
 2. You're getting runtime errors like:
    ```
@@ -47,7 +47,7 @@
    Be sure to add `opencv_img_hash460` to your `OPENCV_LINK_LIBS` environment variable because it's being built as a separate
    file.
 
-7. On macOS you're getting the `dyld: Library not loaded: @rpath/libclang.dylib` error during the build process.
+7. On macOS, you're getting the `dyld: Library not loaded: @rpath/libclang.dylib` error during the build process.
 
    OS can't find `libclang.dylib` dynamic library because it resides in a non-standard path, set up
    the `DYLD_FALLBACK_LIBRARY_PATH` environment variable to point to the path where libclang.dylib can be
@@ -89,15 +89,5 @@
 
 ## Reporting issues
 
-If you still have trouble using the crate after going through the Troubleshooting steps please fill free to
+If you still have trouble using the crate after going through the Troubleshooting steps, please fill free to
 report it to the [bugtracker](https://github.com/twistedfall/opencv-rust/issues).
-
-When reporting an issue please state:
-
-1. Operating system
-2. The way you installed OpenCV: package, official binary distribution, manual compilation, etc.
-3. OpenCV version
-4. Attach the full output of the following command from your project directory:
-   ```shell script
-   RUST_BACKTRACE=full cargo build -vv
-   ```

binding-generator/src/comment.rs

@@ -20,8 +20,8 @@ pub fn strip_doxygen_comment_markers(comment: &str) -> String {
 	let mut comment_type = CommentType::SingleLineDelimited;
 	let mut lines = Vec::with_capacity(128);
 	// first pass:
-	// 1. checks whether the comment is single-line or multi-line delimited
-	// 2. checks whether multiline comment is asterisk prefixed
+	// 1. checks whether a comment is single-line or multi-line delimited
+	// 2. checks whether a multiline comment is asterisk prefixed
 	// 3. strips comment delimiters for multiline and single line comments
 	// 4. collects resulting stripped lines into `lines` Vec
 	for (i, mut line) in comment.lines_with_nl().enumerate() {
@@ -144,16 +144,169 @@ mod test {
 		assert_eq!("test", &strip_doxygen_comment_markers("//   test"));
 		assert_eq!("test", &strip_doxygen_comment_markers("/*test */"));
 
+		// multiline with prefix
 		{
-			let comment = "/** @overload
- * @brief It's the same function as #calibrateCameraAruco but without calibration error estimation.
- */";
+			let comment = "\
+/**
+ * line1
+ * line2
+ */
+";
+			let expected = "\
+line1
+line2";
+			assert_eq!(expected, &strip_doxygen_comment_markers(comment));
+		}
 
-			let expected = "@overload
-@brief It's the same function as #calibrateCameraAruco but without calibration error estimation.";
+		// multiline without prefix
+		{
+			let comment = "\
+/*
+line1
+ line2
+*/
+";
+			let expected = "\
+line1
+ line2";
+			assert_eq!(expected, &strip_doxygen_comment_markers(comment));
+		}
+
+		// multiline with indent and no end marker
+		{
+			let comment = "\
+/** line1
+ *     line2
+ *     line3
+";
+			let expected = "\
+line1
+line2
+line3";
+			assert_eq!(expected, &strip_doxygen_comment_markers(comment));
+		}
+
+		// multiline with MD unordered list
+		{
+			let comment = "\
+/* line1
+      * line2
+        line3
+      * line4
+*/
+";
+			let expected = "\
+line1
+* line2
+  line3
+* line4";
+			assert_eq!(expected, &strip_doxygen_comment_markers(comment));
+		}
+
+		// multiline with indent on a single line
+		{
+			let comment = "\
+/**
+ * line1
+ * line2
+                          line3
+ */
+";
+			let expected = "\
+line1
+line2
+                       line3";
+			assert_eq!(expected, &strip_doxygen_comment_markers(comment));
+		}
+
+		// multiline, end marker on the same line
+		{
+			let comment = "\
+/** line1
+    line2
+    line3*/
+";
+			let expected = "\
+line1
+line2
+line3";
+			assert_eq!(expected, &strip_doxygen_comment_markers(comment));
+		}
+
+		// two multiline glued
+		{
+			let comment = "\
+/** line1
+  line2*/
+/** line3 */
+";
+			let expected = "\
+line1
+  line2
+line3";
+			assert_eq!(expected, &strip_doxygen_comment_markers(comment));
+		}
+
+		// multiline with empty lines inside and at the end
+		{
+			let comment = "\
+/** line1
+
+line2
+
+*/
+";
+			let expected = "\
+line1
+
+line2";
+			assert_eq!(expected, &strip_doxygen_comment_markers(comment));
+		}
+
+		// multiline with empty lines and indent
+		{
+			let comment = "\
+/**
+ line1
+
+ line2
+*/
+";
+			let expected = "\
+line1
+
+line2";
+			assert_eq!(expected, &strip_doxygen_comment_markers(comment));
+		}
+
+		// multiline with indent when the first line is on the same line as the start marker
+		{
+			let comment = "\
+/** line1
+
+ line2
+ */
+";
+			let expected = "\
+line1
+
+line2";
+			assert_eq!(expected, &strip_doxygen_comment_markers(comment));
+		}
+
+		// single-line with exclamation mark
+		{
+			let comment = "\
+//!< line1
+      //!< line2
+";
+			let expected = "\
+line1
+line2";
 			assert_eq!(expected, &strip_doxygen_comment_markers(comment));
 		}
 
+		// single-line
 		{
 			let comment = "// @overload
 // @brief It's the same function as #calibrateCameraAruco but without calibration error estimation.