Skip to content

Commit

Permalink
Javadocs fixes.
Browse files Browse the repository at this point in the history
Signed-off-by: Simone Bordet <simone.bordet@gmail.com>
  • Loading branch information
sbordet committed Nov 20, 2020
1 parent 7726c2e commit 428d60b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ public ClientConnectionFactory getClientConnectionFactory()
* Tests whether one of the protocols of this class is also present in the given candidates list.
*
* @param candidates the candidates to match against
* @param secure whether the protocol should be a secure one
* @return whether one of the protocols of this class is present in the candidates
*/
public boolean matches(List<String> candidates, boolean secure)
Expand Down
8 changes: 4 additions & 4 deletions jetty-io/src/main/java/org/eclipse/jetty/io/EndPoint.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
/**
* <p>EndPoint is the abstraction for an I/O channel that transports bytes.</p>
*
* <h3>Asynchronous Methods</h3>
* <p>Asynchronous Methods</p>
* <p>The asynchronous scheduling methods of {@link EndPoint}
* has been influenced by NIO.2 Futures and Completion
* handlers, but does not use those actual interfaces because they have
Expand All @@ -42,7 +42,7 @@
* implementations of {@link Callback}, such as {@link FutureCallback} and
* {@link IteratingCallback}.</p>
*
* <h3>Reads</h3>
* <p>Reads</p>
* <p>A {@link FutureCallback} can be used to block until an endpoint is ready
* to fill bytes - the notification will be emitted by the NIO subsystem:</p>
* <pre>
Expand All @@ -56,7 +56,7 @@
* int filled = endPoint.fill(byteBuffer);
* </pre>
*
* <h3>Asynchronous Reads</h3>
* <p>Asynchronous Reads</p>
* <p>A {@link Callback} can be used to read asynchronously in its own dispatched
* thread:</p>
* <pre>
Expand All @@ -77,7 +77,7 @@
* });
* </pre>
*
* <h3>Blocking Writes</h3>
* <p>Blocking Writes</p>
* <p>The write contract is that the callback is completed when all the bytes
* have been written or there is a failure.
* Blocking writes look like this:</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,10 @@
import org.slf4j.LoggerFactory;

/**
* JDBCLoginModule
* <p>
* JAAS LoginModule to retrieve user information from
* a database and authenticate the user.
* <h1>Notes</h1>
* <p>This version uses plain old JDBC connections NOT
* Datasources.
* <p>JAAS LoginModule to retrieve user information from
* a database and authenticate the user.</p>
* <p>Notes</p>
* <p>This version uses plain old JDBC connections NOT DataSources.</p>
*/
public class JDBCLoginModule extends AbstractDatabaseLoginModule
{
Expand All @@ -51,7 +48,6 @@ public class JDBCLoginModule extends AbstractDatabaseLoginModule
*
* @return the connection for this datasource
* @throws Exception if unable to get the connection
* @see AbstractDatabaseLoginModule#getConnection()
*/
@Override
public Connection getConnection()
Expand Down

0 comments on commit 428d60b

Please sign in to comment.