[libvirt] [PATCH] [libvirt-java] Fix javadoc warnings.

Claudio Bley cbley at av-test.de
Thu Jul 19 12:31:45 UTC 2012 

ping... ?!

Isn't this the appropriate list? What's the status of libvirt-java?

Best Regards,
Claudio

At Mon, 09 Jul 2012 10:23:42 +0200,
Claudio Bley wrote:
> Here's a patch fixing these javadoc warnings:
> 
> ---
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Connect.java:387: warning - @return tag has no arguments.
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Connect.java:644: warning - @return tag has no arguments.
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Connect.java:658: warning - @return tag has no arguments.
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Domain.java:681: warning - @return tag has no arguments.
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Domain.java:795: warning - Tag @see: reference not found: http
>   [javadoc]       ://www.libvirt.org/html/libvirt-libvirt.html#virDomainMigrateToURI
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\DomainSnapshot.java:40: warning - @return tag has no arguments.
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\StoragePool.java:349: warning - @return tag has no arguments.
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Stream.java:130: warning - Tag @see:illegal character: "58" in "http://www.libvirt.org/html/libvi
> rt-libvirt.html#virStreamRecvAll"
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Stream.java:130: warning - Tag @see:illegal character: "47" in "http://www.libvirt.org/html/libvi
> rt-libvirt.html#virStreamRecvAll"
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Stream.java:130: warning - Tag @see:illegal character: "47" in "http://www.libvirt.org/html/libvi
> rt-libvirt.html#virStreamRecvAll"
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Stream.java:130: warning - Tag @see:illegal character: "47" in "http://www.libvirt.org/html/libvi
> rt-libvirt.html#virStreamRecvAll"
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Stream.java:130: warning - Tag @see:illegal character: "47" in "http://www.libvirt.org/html/libvi
> rt-libvirt.html#virStreamRecvAll"
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Stream.java:130: warning - Tag @see:illegal character: "45" in "http://www.libvirt.org/html/libvi
> rt-libvirt.html#virStreamRecvAll"
>   [javadoc] x:\src\libvirt-java\src\main\java\org\libvirt\Stream.java:130: warning - Tag @see: reference not found: http://www.libvirt.org/html/libvirt-lib
> virt.html#virStreamRecvAll
> ---
> 
> ---
> diff --git a/src/main/java/org/libvirt/Connect.java b/src/main/java/org/libvirt/Connect.java
> index 77336f0..de75f20 100644
> --- a/src/main/java/org/libvirt/Connect.java
> +++ b/src/main/java/org/libvirt/Connect.java
> @@ -381,7 +381,7 @@ public class Connect {
>       *      Documentation</a>
>       * @param callbackID
>       *            the callback to deregister
> -     * @return
> +     * @return 0 on success, -1 on failure
>       * @throws LibvirtException
>       */
>      public int domainEventDeregister(int callbackID) throws LibvirtException {
> @@ -400,7 +400,7 @@ public class Connect {
>                                 int action);
>          }
>  
> -        private interface GenericCallback {
> +        protected interface GenericCallback {
>              void eventCallback(Connect connect, Domain domain);
>          }
>          public interface RebootCallback extends GenericCallback {
> @@ -638,7 +638,7 @@ public class Connect {
>       * domain configuration file describing the domain. The format of the native
>       * data is hypervisor dependant.
>       *
> -     * @return
> +     * @return domain XML as String, or {@code null} on error
>       * @throws LibvirtException
>       */
>      public String domainXMLFromNative(String nativeFormat, String nativeConfig, int flags) throws LibvirtException {
> @@ -652,7 +652,7 @@ public class Connect {
>       * native configuration file describing the domain. The format of the native
>       * data is hypervisor dependant.
>       *
> -     * @return
> +     * @return domain XML as String, or {@code null} on error
>       * @throws LibvirtException
>       */
>      public String domainXMLToNative(String nativeFormat, String domainXML, int flags) throws LibvirtException {
> diff --git a/src/main/java/org/libvirt/Domain.java b/src/main/java/org/libvirt/Domain.java
> index fd7a03a..fe9f3b0 100644
> --- a/src/main/java/org/libvirt/Domain.java
> +++ b/src/main/java/org/libvirt/Domain.java
> @@ -675,7 +675,7 @@ public class Domain {
>       * @see <a
>       *      href="http://www.libvirt.org/html/libvirt-libvirt.html#virDomainManagedSaveRemove">Libvirt
>       *      Documentation</a>
> -     * @return
> +     * @return 0 in case of success, and -1 in case of error
>       * @throws LibvirtException
>       */
>      public int managedSaveRemote() throws LibvirtException {
> @@ -778,8 +778,9 @@ public class Domain {
>       * Migrate the domain object from its current host to the destination host
>       * given by duri.
>       *
> -     * @see http
> -     *      ://www.libvirt.org/html/libvirt-libvirt.html#virDomainMigrateToURI
> +     * @see <a
> +     *       href="http://www.libvirt.org/html/libvirt-libvirt.html#virDomainMigrateToURI">
> +     *       virDomainMigrateToURI</a>
>       *
>       * @param uri
>       *            The destination URI
> diff --git a/src/main/java/org/libvirt/DomainSnapshot.java b/src/main/java/org/libvirt/DomainSnapshot.java
> index e9a23d6..add6830 100644
> --- a/src/main/java/org/libvirt/DomainSnapshot.java
> +++ b/src/main/java/org/libvirt/DomainSnapshot.java
> @@ -34,7 +34,7 @@ public class DomainSnapshot {
>       *      Documentation</a>
>       * @param flags
>       *            controls teh deletion
> -     * @return
> +     * @return 0 if the selected snapshot(s) were successfully deleted, -1 on error.
>       * @throws LibvirtException
>       */
>      public int delete(int flags) throws LibvirtException {
> diff --git a/src/main/java/org/libvirt/StoragePool.java b/src/main/java/org/libvirt/StoragePool.java
> index a3d59a9..0328d8c 100644
> --- a/src/main/java/org/libvirt/StoragePool.java
> +++ b/src/main/java/org/libvirt/StoragePool.java
> @@ -343,7 +343,7 @@ public class StoragePool {
>       * as input. Information for the new volume (name, perms) are passed via a
>       * typical volume XML description.
>       *
> -     * @return
> +     * @return The storage volume, or {@code null} on error.
>       * @throws LibvirtException
>       */
>      public StorageVol storageVolCreateXMLFrom(String xmlDesc, StorageVol cloneVolume, int flags)
> diff --git a/src/main/java/org/libvirt/Stream.java b/src/main/java/org/libvirt/Stream.java
> index fdef3a4..6374567 100644
> --- a/src/main/java/org/libvirt/Stream.java
> +++ b/src/main/java/org/libvirt/Stream.java
> @@ -121,7 +121,7 @@ public class Stream {
>      /**
>       * Batch receive method
>       *
> -     * @see http://www.libvirt.org/html/libvirt-libvirt.html#virStreamRecvAll
> +     * @see <a href="http://www.libvirt.org/html/libvirt-libvirt.html#virStreamRecvAll">virStreamRecvAll</a>
>       * @param handler
>       *            the callback handler
>       * @return 0 if successfule, -1 otherwise
> 
> ---
 
-- 
AV-Test GmbH, Henricistraße 20, 04155 Leipzig, Germany
Phone: +49 341 265 310 19
Web:<http://www.av-test.org>

Eingetragen am / Registered at: Amtsgericht Stendal (HRB 114076)
Geschaeftsfuehrer (CEO): Andreas Marx, Guido Habicht, Maik Morgenstern

More information about the libvir-list mailing list