[jcifs] Javadoc for all classes [patch]
Marcin Cieslak
saper at sgh.waw.pl
Fri Feb 25 23:41:06 GMT 2005
I have grabbed 1.1.8 recently and I've found that Javadoc is built only
for few source files. Javadoc also produced lots of warnings.
Please see attached patch to fix this simple issue.
--Marcin
-------------- next part --------------
diff -ruN jcifs_1.1.8.orig/build.xml jcifs_1.1.8/build.xml
--- jcifs_1.1.8.orig/build.xml Thu Feb 10 22:30:18 2005
+++ jcifs_1.1.8/build.xml Fri Feb 25 19:06:24 2005
@@ -66,10 +66,9 @@
author="true"
version="true"
use="true"
- sourcefiles="src/jcifs/Config.java,src/jcifs/UniAddress.java,src/jcifs/netbios/NbtAddress.java,src/jcifs/smb/DosFileFilter.java,src/jcifs/smb/NtlmAuthenticator.java,src/jcifs/smb/NtlmPasswordAuthentication.java,src/jcifs/smb/SmbAuthException.java,src/jcifs/smb/SmbException.java,src/jcifs/smb/SmbFile.java,src/jcifs/smb/SmbFileFilter.java,src/jcifs/smb/SmbFileInputStream.java,src/jcifs/smb/SmbFilenameFilter.java,src/jcifs/smb/SmbFileOutputStream.java,src/jcifs/smb/SmbNamedPipe.java,src/jcifs/smb/SmbRandomAccessFile.java,src/jcifs/smb/SmbSession.java"
- windowtitle="JCIFS API">
+ windowtitle="JCIFS API" packagenames="*">
- <sourcepath path="src"/>
+ <sourcepath path="src/"/>
<classpath>
<pathelement path="${java.class.path}"/>
<fileset dir=".">
diff -ruN jcifs_1.1.8.orig/src/jcifs/UniAddress.java jcifs_1.1.8/src/jcifs/UniAddress.java
--- jcifs_1.1.8.orig/src/jcifs/UniAddress.java Thu Feb 10 22:30:18 2005
+++ jcifs_1.1.8/src/jcifs/UniAddress.java Fri Feb 25 20:36:08 2005
@@ -192,7 +192,7 @@
* Determines the address of a host given it's host name. The name can be a
* machine name like "jcifs.samba.org", or an IP address like "192.168.1.15".
*
- * @param host NetBIOS or DNS hostname to resolve
+ * @param hostname NetBIOS or DNS hostname to resolve
* @throws java.net.UnknownHostException if there is an error resolving the name
*/
diff -ruN jcifs_1.1.8.orig/src/jcifs/ntlmssp/Type3Message.java jcifs_1.1.8/src/jcifs/ntlmssp/Type3Message.java
--- jcifs_1.1.8.orig/src/jcifs/ntlmssp/Type3Message.java Thu Feb 10 22:30:18 2005
+++ jcifs_1.1.8/src/jcifs/ntlmssp/Type3Message.java Fri Feb 25 20:37:59 2005
@@ -182,7 +182,7 @@
*
* @param flags The flags to apply to this message.
* @param lmResponse The LanManager/LMv2 response.
- * @param domain The NT/NTLMv2 response.
+ * @param ntResponse The NT/NTLMv2 response.
* @param domain The domain in which the user has an account.
* @param user The username for the authenticating user.
* @param workstation The workstation from which authentication is
@@ -238,7 +238,7 @@
/**
* Sets the NT/NTLMv2 response for this message.
*
- * @param lmResponse The NT/NTLMv2 response.
+ * @param ntResponse The NT/NTLMv2 response.
*/
public void setNTResponse(byte[] ntResponse) {
this.ntResponse = ntResponse;
diff -ruN jcifs_1.1.8.orig/src/jcifs/smb/SmbFile.java jcifs_1.1.8/src/jcifs/smb/SmbFile.java
--- jcifs_1.1.8.orig/src/jcifs/smb/SmbFile.java Thu Feb 10 22:30:20 2005
+++ jcifs_1.1.8/src/jcifs/smb/SmbFile.java Fri Feb 25 20:48:59 2005
@@ -2001,7 +2001,7 @@
* servers.
*
* @param dest the destination file or directory
- * @throw SmbException
+ * @throws SmbException
*/
public void copyTo( SmbFile dest ) throws SmbException {
SmbComReadAndX req;
@@ -2145,7 +2145,7 @@
*
* @return The length of the file in bytes or 0 if this
* <code>SmbFile</code> is not a file.
- * @throw SmbException
+ * @throws SmbException
*/
public long length() throws SmbException {
@@ -2320,7 +2320,7 @@
* the <tt>setAttributes()</tt> method.
*
* @return the <tt>ATTR_*</tt> attributes associated with this file
- * @throw SmbException
+ * @throws SmbException
*/
public int getAttributes() throws SmbException {
if( getUncPath0().length() == 1 ) {
@@ -2335,7 +2335,7 @@
* bitset by bitwise ORing the <tt>ATTR_*</tt> constants. Setting the
* value returned by <tt>getAttributes</tt> will result in both files
* having the same attributes.
- * @throw SmbException
+ * @throws SmbException
*/
public void setAttributes( int attrs ) throws SmbException {
if( getUncPath0().length() == 1 ) {
@@ -2349,7 +2349,7 @@
* Make this file read-only. This is shorthand for <tt>setAttributes(
* getAttributes() | ATTR_READ_ONLY )</tt>.
*
- * @throw SmbException
+ * @throws SmbException
*/
public void setReadOnly() throws SmbException {
setAttributes( getAttributes() | ATTR_READONLY );
@@ -2359,7 +2359,7 @@
* Turn off the read-only attribute of this file. This is shorthand for
* <tt>setAttributes( getAttributes() & ~ATTR_READONLY )</tt>.
*
- * @throw SmbException
+ * @throws SmbException
*/
public void setReadWrite() throws SmbException {
setAttributes( getAttributes() & ~ATTR_READONLY );
@@ -2371,9 +2371,9 @@
* access an SMB resource. Currently only retrieving data and information
* is supported (i.e. no <tt>doOutput</tt>).
*
- * @depricated Use getURL() instead
+ * @deprecated Use getURL() instead
* @return A new <code>{@link java.net.URL}</code> for this <code>SmbFile</code>
- * @throw MalformedURLException
+ * @throws MalformedURLException
*/
public URL toURL() throws MalformedURLException {
return url;
@@ -2389,7 +2389,7 @@
* to make such a determination.
*
* @return A hashcode for this abstract file
- * @throw SmbException
+ * @throws SmbException
*/
public int hashCode() {
@@ -2423,7 +2423,7 @@
* @param obj Another <code>SmbFile</code> object to compare for equality
* @return <code>true</code> if the two objects refer to the same SMB resource
* and <code>false</code> otherwise
- * @throw SmbException
+ * @throws SmbException
*/
public boolean equals( Object obj ) {
@@ -2437,7 +2437,7 @@
* as <code>getPath</code>.
*
* @return The original URL representation of this SMB resource
- * @throw SmbException
+ * @throws SmbException
*/
public String toString() {
@@ -2488,7 +2488,7 @@
/**
* This URLConnection method just returns a new <tt>SmbFileInputStream</tt> created with this file.
*
- * @throw IOException thrown by <tt>SmbFileInputStream</tt> constructor
+ * @throws IOException thrown by <tt>SmbFileInputStream</tt> constructor
*/
public InputStream getInputStream() throws IOException {
return new SmbFileInputStream( this );
@@ -2497,7 +2497,7 @@
/**
* This URLConnection method just returns a new <tt>SmbFileOutputStream</tt> created with this file.
*
- * @throw IOException thrown by <tt>SmbFileOutputStream</tt> constructor
+ * @throws IOException thrown by <tt>SmbFileOutputStream</tt> constructor
*/
public OutputStream getOutputStream() throws IOException {
return new SmbFileOutputStream( this );
diff -ruN jcifs_1.1.8.orig/src/jcifs/smb/SmbFileInputStream.java jcifs_1.1.8/src/jcifs/smb/SmbFileInputStream.java
--- jcifs_1.1.8.orig/src/jcifs/smb/SmbFileInputStream.java Thu Feb 10 22:30:20 2005
+++ jcifs_1.1.8/src/jcifs/smb/SmbFileInputStream.java Fri Feb 25 20:42:34 2005
@@ -43,7 +43,6 @@
* URL syntax.
*
* @param url An smb URL string representing the file to read from
- * @return A new <code>InputStream</code> for the specified <code>SmbFile</code>
*/
public SmbFileInputStream( String url ) throws SmbException, MalformedURLException, UnknownHostException {
@@ -56,8 +55,7 @@
* {@link jcifs.smb.SmbFile} for a detailed description and examples of
* the smb URL syntax.
*
- * @param url An smb URL string representing the file to write to
- * @return A new <code>InputStream</code> for the specified <code>SmbFile</code>
+ * @param file An smb URL string representing the file to write to
*/
public SmbFileInputStream( SmbFile file ) throws SmbException, MalformedURLException, UnknownHostException {
diff -ruN jcifs_1.1.8.orig/src/jcifs/smb/SmbFileOutputStream.java jcifs_1.1.8/src/jcifs/smb/SmbFileOutputStream.java
--- jcifs_1.1.8.orig/src/jcifs/smb/SmbFileOutputStream.java Thu Feb 10 22:30:20 2005
+++ jcifs_1.1.8/src/jcifs/smb/SmbFileOutputStream.java Fri Feb 25 20:47:51 2005
@@ -48,7 +48,6 @@
* the smb URL syntax.
*
* @param url An smb URL string representing the file to write to
- * @return A new <code>OutputStream</code> for the specified file
*/
public SmbFileOutputStream( String url ) throws SmbException, MalformedURLException, UnknownHostException {
@@ -61,8 +60,7 @@
* {@link jcifs.smb.SmbFile} for a detailed description and examples of
* the smb URL syntax.
*
- * @param url An <code>SmbFile</code> specifying the file to write to
- * @return A new <code>OutputStream</code> for the specified <code>SmbFile</code>
+ * @param file An <code>SmbFile</code> specifying the file to write to
*/
public SmbFileOutputStream( SmbFile file ) throws SmbException, MalformedURLException, UnknownHostException {
@@ -77,7 +75,7 @@
* end of the file rather than the beginning.
*
* @param url An smb URL string representing the file to write to
- * @return A new <code>OutputStream</code> for the specified <code>url</code>
+ * @param append Append to the end of file if true or overwrite if false
*/
public SmbFileOutputStream( String url, boolean append ) throws SmbException, MalformedURLException, UnknownHostException {
@@ -91,8 +89,8 @@
* the smb URL syntax. If the second argument is <code>true</code>, then
* bytes will be written to the end of the file rather than the beginning.
*
- * @param url An <code>SmbFile</code> representing the file to write to
- * @return A new <code>OutputStream</code> for the specified <code>SmbFile</code>
+ * @param file An <code>SmbFile</code> representing the file to write to
+ * @param append Append to the end of file if true or overwrite if false
*/
public SmbFileOutputStream( SmbFile file, boolean append ) throws SmbException, MalformedURLException, UnknownHostException {
@@ -115,7 +113,7 @@
write, and/or delete the file while the jCIFS user has the file open.
*
* @param url An <code>SmbFile</code> representing the file to write to
- * @return A new <code>OutputStream</code> for the specified <code>SmbFile</code>
+ * @param shareAccess File sharing flag: <code>SmbFile.FILE_NOSHARE</code>|<code>SmbFile.FILE_READ</code>|<code>SmbFile.FILE_WRITE</code>|<code>SmbFile.FILE_DELETE</code>
*/
public SmbFileOutputStream( String url, int shareAccess ) throws SmbException, MalformedURLException, UnknownHostException {
diff -ruN jcifs_1.1.8.orig/src/jcifs/util/Hexdump.java jcifs_1.1.8/src/jcifs/util/Hexdump.java
--- jcifs_1.1.8.orig/src/jcifs/util/Hexdump.java Thu Feb 10 22:30:20 2005
+++ jcifs_1.1.8/src/jcifs/util/Hexdump.java Fri Feb 25 20:35:21 2005
@@ -130,12 +130,6 @@
return new String( c );
}
-/**
- * This is the same as {@link jcifs.util.Log#toHexString(int val, int
- * size)} but provides a more practical form when trying to avoid {@link
- * java.lang.String} concatenation and {@link java.lang.StringBuffer}.
- */
-
public static void toHexChars( int val, char dst[], int dstIndex, int size ) {
while( size > 0 ) {
int i = dstIndex + size - 1;
More information about the jcifs
mailing list