Skip to content

Commit

Permalink
Normalize getter Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Oct 31, 2023
1 parent be56c8d commit 7ef18ef
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ private void byteArrayDataSource(final InputStream aIs)
}

/**
* Get the content type.
* Gets the content type.
*
* @return A String.
* @since 1.0
Expand All @@ -188,7 +188,7 @@ public String getContentType()
}

/**
* Get the input stream.
* Gets the input stream.
*
* @return An InputStream.
* @throws IOException IOException
Expand Down Expand Up @@ -216,7 +216,7 @@ public void setName(final String name)
}

/**
* Get the name.
* Gets the name.
*
* @return A String.
* @since 1.0
Expand All @@ -228,7 +228,7 @@ public String getName()
}

/**
* Get the OutputStream to write to.
* Gets the OutputStream to write to.
*
* @return An OutputStream
* @since 1.0
Expand Down
12 changes: 6 additions & 6 deletions src/main/java/org/apache/commons/mail/Email.java
Original file line number Diff line number Diff line change
Expand Up @@ -1803,7 +1803,7 @@ public Email setSendPartial(final boolean sendPartial)
}

/**
* Get the list of "To" addresses.
* Gets the list of "To" addresses.
*
* @return List addresses
*/
Expand All @@ -1813,7 +1813,7 @@ public List<InternetAddress> getToAddresses()
}

/**
* Get the list of "CC" addresses.
* Gets the list of "CC" addresses.
*
* @return List addresses
*/
Expand All @@ -1823,7 +1823,7 @@ public List<InternetAddress> getCcAddresses()
}

/**
* Get the list of "Bcc" addresses.
* Gets the list of "Bcc" addresses.
*
* @return List addresses
*/
Expand All @@ -1833,7 +1833,7 @@ public List<InternetAddress> getBccAddresses()
}

/**
* Get the list of "Reply-To" addresses.
* Gets the list of "Reply-To" addresses.
*
* @return List addresses
*/
Expand All @@ -1843,7 +1843,7 @@ public List<InternetAddress> getReplyToAddresses()
}

/**
* Get the socket connection timeout value in milliseconds.
* Gets the socket connection timeout value in milliseconds.
*
* @return the timeout in milliseconds.
* @since 1.2
Expand All @@ -1868,7 +1868,7 @@ public void setSocketConnectionTimeout(final int socketConnectionTimeout)
}

/**
* Get the socket I/O timeout value in milliseconds.
* Gets the socket I/O timeout value in milliseconds.
*
* @return the socket I/O timeout
* @since 1.2
Expand Down
10 changes: 5 additions & 5 deletions src/main/java/org/apache/commons/mail/EmailAttachment.java
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public class EmailAttachment
private String disposition = EmailAttachment.ATTACHMENT;

/**
* Get the description.
* Gets the description.
*
* @return A String.
* @since 1.0
Expand All @@ -58,7 +58,7 @@ public String getDescription()
}

/**
* Get the name.
* Gets the name.
*
* @return A String.
* @since 1.0
Expand All @@ -69,7 +69,7 @@ public String getName()
}

/**
* Get the path.
* Gets the path.
*
* @return A String.
* @since 1.0
Expand All @@ -80,7 +80,7 @@ public String getPath()
}

/**
* Get the URL.
* Gets the URL.
*
* @return A URL.
* @since 1.0
Expand All @@ -91,7 +91,7 @@ public URL getURL()
}

/**
* Get the disposition.
* Gets the disposition.
*
* @return A String.
* @since 1.0
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/apache/commons/mail/ImageHtmlEmail.java
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public class ImageHtmlEmail extends HtmlEmail
private DataSourceResolver dataSourceResolver;

/**
* Get the data source resolver.
* Gets the data source resolver.
*
* @return the resolver
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/apache/commons/mail/MultiPartEmail.java
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public void setSubType(final String aSubType)
}

/**
* Get the MIME subtype of the email.
* Gets the MIME subtype of the email.
*
* @return MIME subtype of the email
* @since 1.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public DataSourceCompositeResolver(final DataSourceResolver[] dataSourceResolver
}

/**
* Get the underlying data source resolvers.
* Gets the underlying data source resolvers.
*
* @return underlying data source resolvers
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public DataSourceFileResolver(final File baseDir, final boolean lenient)
}

/**
* Get the base directory used for resolving relative resource locations.
* Gets the base directory used for resolving relative resource locations.
*
* @return the baseUrl
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public DataSourceUrlResolver(final URL baseUrl, final boolean lenient)
}

/**
* Get the base URL used for resolving relative resource locations.
* Gets the base URL used for resolving relative resource locations.
*
* @return the baseUrl
*/
Expand Down

0 comments on commit 7ef18ef

Please sign in to comment.