[med-svn] [imagej] 04/10: New package libij-java-doc for ij.jar javadocs

[Carnë Draug]

This is an automated email from the git hooks/post-receive script.

carandraug-guest pushed a commit to branch master
in repository imagej.

commit 29a6a9777045237977828d0b00a59a1715ccf74b
Author: Carnë Draug <carandraug+dev at gmail.com>
Date:   Thu Aug 24 10:55:18 2017 +0100

    New package libij-java-doc for ij.jar javadocs
---
 debian/changelog                   | 13 ++++++-------
 debian/control                     | 13 +++++++++++++
 debian/libij-java-doc.doc-base.api | 10 ++++++++++
 debian/libij-java-doc.install      |  1 +
 debian/patches/link-javadocs.patch | 13 +++++++++++++
 debian/patches/series              |  1 +
 debian/rules                       |  6 +++++-
 7 files changed, 49 insertions(+), 8 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 82d3294..61084b4 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -4,8 +4,6 @@ imagej (1.51p+dfsg-1) UNRELEASED; urgency=medium
   - We copy the icon for hicolor fromt the binary release.  This image is
     not included in the source releases, only the lower quality
     microscope.gif..  We should request that from upstream.
-  - Have separate libimagej-java-doc package so that Java libraries
-    dependent on ij.jar can be built.
   - Drop the exclusion of files during repackaging.  Upstream now
     requested to exclude them
     https://list.nih.gov/cgi-bin/wa.exe?A2=IMAGEJ;d7c90ffd.1708
@@ -16,13 +14,14 @@ imagej (1.51p+dfsg-1) UNRELEASED; urgency=medium
   * New upstream release
 
   [ Carnë Draug ]
+  * Two new packages named libij-java and libij-java-doc have been
+    created.  The libij-java packages has the ij.jar artifact and the
+    maven pom.xml as distributed by the ImageJA project.  The
+    libij-java-doc package has the corresponding javadocs.  This enables
+    the packaging of ImageJ plugins that make use of maven and other
+    programs and libraries that are dependent on ij.jar.
   * Added ImageJ to the Education and ImageProcessing category on the
     desktop file.
-  * Include the maven pom.xml file for artifact ij in group net.imagej
-    which is part of ImageJA.  This enables the packaging of ImageJ
-    plugins which often use maven.
-  * A new package named libij-java has been created with the ij artifact
-    alone.
   * Install the upstream changelog file, the release-notes file, as
     the changelog file instead of just another file in docs.
   * Do not install IJ_Props.txt as docs.  This file is included in ij.jar
diff --git a/debian/control b/debian/control
index 6ac89a0..2fb5321 100644
--- a/debian/control
+++ b/debian/control
@@ -6,6 +6,7 @@ Section: science
 Priority: optional
 Build-Depends: debhelper (>= 10)
 Build-Depends-Indep: ant,
+ default-jdk-doc,
  default-jdk-headless,
  javahelper,
  maven-repo-helper
@@ -49,3 +50,15 @@ Description: Java library for ImageJ
  on microscopy images.
  .
  This package contains the Java library to make use of ImageJ.
+
+Package: libij-java-doc
+Architecture: all
+Section: doc
+Depends: ${misc:Depends}
+Recommends: ${maven:DocDepends}, ${maven:DocOptionalDepends}
+Suggests: libij-java
+Description: documentation of libij-java
+ ImageJ is a program for image analysis and processing, with a focus
+ on microscopy images.
+ .
+ This package contains the API documentation of libij-java.
diff --git a/debian/libij-java-doc.doc-base.api b/debian/libij-java-doc.doc-base.api
new file mode 100644
index 0000000..718427b
--- /dev/null
+++ b/debian/libij-java-doc.doc-base.api
@@ -0,0 +1,10 @@
+Document: libij-java
+Title: API Javadoc for ImageJ
+Author: ImageJ developers
+Abstract: This is the API Javadoc provided for the
+ libij-java library.
+Section: Programming
+
+Format: HTML
+Index: /usr/share/doc/libij-java/api/index.html
+Files: /usr/share/doc/libij-java/api/*
diff --git a/debian/libij-java-doc.install b/debian/libij-java-doc.install
new file mode 100644
index 0000000..3986bc2
--- /dev/null
+++ b/debian/libij-java-doc.install
@@ -0,0 +1 @@
+../api/* usr/share/doc/libij-java/api
diff --git a/debian/patches/link-javadocs.patch b/debian/patches/link-javadocs.patch
new file mode 100644
index 0000000..ab8727e
--- /dev/null
+++ b/debian/patches/link-javadocs.patch
@@ -0,0 +1,13 @@
+Description: link javadocs to other packages
+Author: Carnë Draug <carandraug+dev at gmail.com>
+Last-Update: 2017-08-24
+--- a/build.xml
++++ b/build.xml
+@@ -66,6 +66,7 @@
+            author="true"
+            version="true"
+            use="true"
++           link="/usr/share/doc/default-jdk-doc/api"
+            windowtitle="ImageJ API">
+     </javadoc>
+   </target>
diff --git a/debian/patches/series b/debian/patches/series
index d21153b..91efa7f 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -2,3 +2,4 @@ exclude-quilt-from-ant.patch
 drop-mac-plugins.patch
 specify-javac-encoding.patch
 fix-javadocs-syntax.patch
+link-javadocs.patch
diff --git a/debian/rules b/debian/rules
index 790cc27..64b5e1d 100755
--- a/debian/rules
+++ b/debian/rules
@@ -4,8 +4,12 @@
 %:
 	dh $@ --buildsystem=ant --with maven-repo-helper --with javahelper
 
+## The default target for ImageJ build is 'run' which causes the build
+## to hang since it is an interactive application (also needs X11).
+## Because of that, we need to override dh_auto_build to only call the
+## build and javadocs targets.
 override_dh_auto_build:
-	ant build
+	ant build javadocs
 
 override_dh_installchangelogs:
 	dh_installchangelogs release-notes.html

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/imagej.git