mirror of
https://github.com/libguestfs/libguestfs.git
synced 2026-03-21 22:53:37 +00:00
java: Tidy up javadoc.
This commit is contained in:
@@ -40,7 +40,19 @@ import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* The GuestFS object is a libguestfs handle.
|
||||
* Libguestfs handle.
|
||||
* <p>
|
||||
* The <code>GuestFS</code> object corresponds to a libguestfs handle.
|
||||
* <p>
|
||||
* Note that the main documentation for the libguestfs API is in
|
||||
* the following man pages:
|
||||
* <p>
|
||||
* <ol>
|
||||
* <li> <a href=\"http://libguestfs.org/guestfs-java.3.html\"><code>guestfs-java(3)</code></a> and </li>
|
||||
* <li> <a href=\"http://libguestfs.org/guestfs.3.html\"><code>guestfs(3)</code></a>. </li>
|
||||
* </ol>
|
||||
* <p>
|
||||
* This javadoc is <b>not</b> a good introduction to using libguestfs.
|
||||
*
|
||||
* @author rjones
|
||||
*/
|
||||
@@ -384,7 +396,7 @@ and generate_java_struct jtyp cols () =
|
||||
package com.redhat.et.libguestfs;
|
||||
|
||||
/**
|
||||
* Libguestfs %s structure.
|
||||
* %s structure.
|
||||
*
|
||||
* @author rjones
|
||||
* @see GuestFS
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/* libguestfs Java bindings
|
||||
* Copyright (C) 2009 Red Hat Inc.
|
||||
* Copyright (C) 2009-2013 Red Hat Inc.
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
@@ -19,6 +19,8 @@
|
||||
package com.redhat.et.libguestfs;
|
||||
|
||||
/**
|
||||
* Libguestfs error class.
|
||||
* <p>
|
||||
* This exception is thrown when some error occurs when using the
|
||||
* libguestfs library. The error message is always a simple
|
||||
* printable string.
|
||||
|
||||
Reference in New Issue
Block a user