* Disable DocLint, which prevents the build from succeeding on Java …

…8 (issue #5)
bytedeco · Nov 1, 2014 · d4df1d3 · d4df1d3
1 parent 4d8dc9d
commit d4df1d3
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,5 @@
 
+ * Disable DocLint, which prevents the build from succeeding on Java 8 ([issue #5](https://github.com/bytedeco/javacpp/issues/5))
  * Add new `indexer` package containing a set of `Indexer` for easy and efficient multidimensional access of arrays and buffers ([issue javacv:317](http://code.google.com/p/javacv/issues/detail?id=317))
  * Use `Long.decode()` inside the `Tokenizer` to test more precisely when integer values are larger than 32 bits
  * Have the `Parser` produce `@Name("operator=") ... put(... )` methods for standard C++ containers, avoiding mistaken calls to `Pointer.put(Pointer)` ([issue javacv:34](https://github.com/bytedeco/javacv/issues/34))

diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ We can also have everything downloaded and installed automatically with:
   }
 ```
 
-* SBT (inside the `build.sbt` file)
+ * SBT (inside the `build.sbt` file)
 ```scala
   libraryDependencies += "org.bytedeco" % "javacpp" % "0.9"
 ```

diff --git a/pom.xml b/pom.xml
@@ -193,6 +193,23 @@
   </build>
 
   <profiles>
+    <profile>
+      <id>doclint-java8-disable</id>
+      <activation>
+        <jdk>[1.8,)</jdk>
+      </activation>
+      <build>
+        <plugins>
+          <plugin>
+            <artifactId>maven-javadoc-plugin</artifactId>
+            <configuration>
+              <additionalparam>-Xdoclint:none</additionalparam>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+
     <profile>
       <id>sign-artifacts</id>
       <activation>

diff --git a/src/main/java/org/bytedeco/javacpp/Pointer.java b/src/main/java/org/bytedeco/javacpp/Pointer.java
@@ -385,6 +385,7 @@ public void deallocate() {
     }
     /**
      * Explicitly deallocates native memory without waiting after the garbage collector.
+     * Has no effect if no deallocator was previously set with {@link #deallocator(Deallocator)}.
      * @param deallocate if false, does not deallocate, rather disabling garbage collection
      */
     public void deallocate(boolean deallocate) {