Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadocs fixes. 

Signed-off-by: Simone Bordet <simone.bordet@gmail.com>
This commit is contained in:
Simone Bordet 2020-11-20 19:02:50 +01:00
parent 7726c2ebcb
commit 428d60bc3c
3 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
jetty-io/src/main/java/org/eclipse/jetty/io/ClientConnectionFactory.java
View File

@ -91,6 +91,7 @@ public interface ClientConnectionFactory
* Tests whether one of the protocols of this class is also present in the given candidates list. * 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 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 * @return whether one of the protocols of this class is present in the candidates
*/ */
public boolean matches(List<String> candidates, boolean secure) public boolean matches(List<String> candidates, boolean secure)

8
jetty-io/src/main/java/org/eclipse/jetty/io/EndPoint.java
View File

@ -33,7 +33,7 @@ import org.eclipse.jetty.util.thread.Invocable;
/** /**
* <p>EndPoint is the abstraction for an I/O channel that transports bytes.</p> * <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} * <p>The asynchronous scheduling methods of {@link EndPoint}
* has been influenced by NIO.2 Futures and Completion * has been influenced by NIO.2 Futures and Completion
* handlers, but does not use those actual interfaces because they have * handlers, but does not use those actual interfaces because they have
@ -42,7 +42,7 @@ import org.eclipse.jetty.util.thread.Invocable;
* implementations of {@link Callback}, such as {@link FutureCallback} and * implementations of {@link Callback}, such as {@link FutureCallback} and
* {@link IteratingCallback}.</p> * {@link IteratingCallback}.</p>
* *
* <h3>Reads</h3> * <p>Reads</p>
* <p>A {@link FutureCallback} can be used to block until an endpoint is ready * <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> * to fill bytes - the notification will be emitted by the NIO subsystem:</p>
* <pre> * <pre>
@ -56,7 +56,7 @@ import org.eclipse.jetty.util.thread.Invocable;
* int filled = endPoint.fill(byteBuffer); * int filled = endPoint.fill(byteBuffer);
* </pre> * </pre>
* *
* <h3>Asynchronous Reads</h3> * <p>Asynchronous Reads</p>
* <p>A {@link Callback} can be used to read asynchronously in its own dispatched * <p>A {@link Callback} can be used to read asynchronously in its own dispatched
* thread:</p> * thread:</p>
* <pre> * <pre>
@ -77,7 +77,7 @@ import org.eclipse.jetty.util.thread.Invocable;
* }); * });
* </pre> * </pre>
* *
* <h3>Blocking Writes</h3> * <p>Blocking Writes</p>
* <p>The write contract is that the callback is completed when all the bytes * <p>The write contract is that the callback is completed when all the bytes
* have been written or there is a failure. * have been written or there is a failure.
* Blocking writes look like this:</p> * Blocking writes look like this:</p>

12
jetty-jaas/src/main/java/org/eclipse/jetty/jaas/spi/JDBCLoginModule.java
View File

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