diff --git a/modules/java/generator/gen_javadoc.py b/modules/java/generator/gen_javadoc.py index 3c697277b..71372d3a2 100755 --- a/modules/java/generator/gen_javadoc.py +++ b/modules/java/generator/gen_javadoc.py @@ -3,6 +3,19 @@ import os, sys, re, string, glob from optparse import OptionParser +# Black list for classes and methods that does not implemented in Java API +# Created to exclude referencies to them in @see tag +JAVADOC_ENTITY_BLACK_LIST = set(["org.opencv.core.Core#abs", \ + "org.opencv.core.Core#theRNG", \ + "org.opencv.core.Core#extractImageCOI", \ + "org.opencv.core.PCA", \ + "org.opencv.core.SVD", \ + "org.opencv.core.RNG", \ + "org.opencv.imgproc.Imgproc#createMorphologyFilter", \ + "org.opencv.imgproc.Imgproc#createLinearFilter", \ + "org.opencv.imgproc.Imgproc#createSeparableLinearFilter", \ + "org.opencv.imgproc.FilterEngine"]) + class JavadocGenerator(object): def __init__(self, definitions = {}, modules= [], javadoc_marker = "//javadoc:"): self.definitions = definitions @@ -214,9 +227,9 @@ class JavadocGenerator(object): for see in decl["seealso"]: seedecl = self.definitions.get(see,None) if seedecl: - doc += prefix + " * @see " + self.getJavaName(seedecl, "#") + "\n" - else: - doc += prefix + " * @see " + see.replace("::",".") + "\n" + javadoc_name = self.getJavaName(seedecl, "#") + if (javadoc_name not in JAVADOC_ENTITY_BLACK_LIST): + doc += prefix + " * @see " + javadoc_name + "\n" prefix = " *\n" #doc += prefix + " * File: " + decl["file"] + " (line " + str(decl["line"]) + ")\n" diff --git a/modules/java/generator/src/java/android+CameraBridgeViewBase.java b/modules/java/generator/src/java/android+CameraBridgeViewBase.java index cd13d1f1a..06288c94f 100644 --- a/modules/java/generator/src/java/android+CameraBridgeViewBase.java +++ b/modules/java/generator/src/java/android+CameraBridgeViewBase.java @@ -344,7 +344,7 @@ public abstract class CameraBridgeViewBase extends SurfaceView implements Surfac * @param supportedSizes * @param surfaceWidth * @param surfaceHeight - * @return + * @return optimal frame size */ protected Size calculateCameraFrameSize(List supportedSizes, ListItemAccessor accessor, int surfaceWidth, int surfaceHeight) { int calcWidth = 0; diff --git a/modules/java/generator/src/java/android+OpenCVLoader.java b/modules/java/generator/src/java/android+OpenCVLoader.java index ce5f4b761..4c3655c12 100644 --- a/modules/java/generator/src/java/android+OpenCVLoader.java +++ b/modules/java/generator/src/java/android+OpenCVLoader.java @@ -31,7 +31,7 @@ public class OpenCVLoader * @param Version OpenCV library version. * @param AppContext application context for connecting to the service. * @param Callback object, that implements LoaderCallbackInterface for handling the connection status. - * @return Returns true if initialization of OpenCV is successful. + * @return Returns true if initialization of OpenCV is successful. */ public static boolean initAsync(String Version, Context AppContext, LoaderCallbackInterface Callback)