Fix javadoc in org.eclipse.jgit.ui

Change-Id: Iec68c73fc0d8d26fdb26850354059ea521ac7fe5
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
This commit is contained in:
Matthias Sohn 2017-12-17 21:46:10 +01:00
parent f677ee4893
commit 6ac27ee215
6 changed files with 31 additions and 5 deletions

View File

@ -84,6 +84,7 @@ void paint(final Graphics in, final PlotCommit<SwingLane> commit) {
} }
} }
/** {@inheritDoc} */
@Override @Override
protected void drawLine(final Color color, int x1, int y1, int x2, protected void drawLine(final Color color, int x1, int y1, int x2,
int y2, int width) { int y2, int width) {
@ -100,6 +101,7 @@ protected void drawLine(final Color color, int x1, int y1, int x2,
g.drawLine(x1, y1, x2, y2); g.drawLine(x1, y1, x2, y2);
} }
/** {@inheritDoc} */
@Override @Override
protected void drawCommitDot(final int x, final int y, final int w, protected void drawCommitDot(final int x, final int y, final int w,
final int h) { final int h) {
@ -110,6 +112,7 @@ protected void drawCommitDot(final int x, final int y, final int w,
g.drawOval(x, y, w, h); g.drawOval(x, y, w, h);
} }
/** {@inheritDoc} */
@Override @Override
protected void drawBoundaryDot(final int x, final int y, final int w, protected void drawBoundaryDot(final int x, final int y, final int w,
final int h) { final int h) {
@ -120,6 +123,7 @@ protected void drawBoundaryDot(final int x, final int y, final int w,
g.drawOval(x, y, w, h); g.drawOval(x, y, w, h);
} }
/** {@inheritDoc} */
@Override @Override
protected void drawText(final String msg, final int x, final int y) { protected void drawText(final String msg, final int x, final int y) {
final int texth = g.getFontMetrics().getHeight(); final int texth = g.getFontMetrics().getHeight();
@ -128,6 +132,7 @@ protected void drawText(final String msg, final int x, final int y) {
g.drawString(msg, x, y0 + texth - g.getFontMetrics().getDescent()); g.drawString(msg, x, y0 + texth - g.getFontMetrics().getDescent());
} }
/** {@inheritDoc} */
@Override @Override
protected Color laneColor(final SwingLane myLane) { protected Color laneColor(final SwingLane myLane) {
return myLane != null ? myLane.color : Color.black; return myLane != null ? myLane.color : Color.black;
@ -147,6 +152,7 @@ void paintTriangleDown(final int cx, final int y, final int h) {
g.drawPolygon(triangle); g.drawPolygon(triangle);
} }
/** {@inheritDoc} */
@Override @Override
protected int drawLabel(int x, int y, Ref ref) { protected int drawLabel(int x, int y, Ref ref) {
String txt; String txt;

View File

@ -58,13 +58,18 @@
import org.eclipse.jgit.util.CachedAuthenticator; import org.eclipse.jgit.util.CachedAuthenticator;
/** Basic network prompt for username/password when using AWT. */ /**
* Basic network prompt for username/password when using AWT.
*/
public class AwtAuthenticator extends CachedAuthenticator { public class AwtAuthenticator extends CachedAuthenticator {
/** Install this authenticator implementation into the JVM. */ /**
* Install this authenticator implementation into the JVM.
*/
public static void install() { public static void install() {
setDefault(new AwtAuthenticator()); setDefault(new AwtAuthenticator());
} }
/** {@inheritDoc} */
@Override @Override
protected PasswordAuthentication promptPasswordAuthentication() { protected PasswordAuthentication promptPasswordAuthentication() {
final GridBagConstraints gbc = new GridBagConstraints(0, 0, 1, 1, 1, 1, final GridBagConstraints gbc = new GridBagConstraints(0, 0, 1, 1, 1, 1,

View File

@ -62,9 +62,13 @@
import org.eclipse.jgit.transport.NetRCCredentialsProvider; import org.eclipse.jgit.transport.NetRCCredentialsProvider;
import org.eclipse.jgit.transport.URIish; import org.eclipse.jgit.transport.URIish;
/** Interacts with the user during authentication by using AWT/Swing dialogs. */ /**
* Interacts with the user during authentication by using AWT/Swing dialogs.
*/
public class AwtCredentialsProvider extends CredentialsProvider { public class AwtCredentialsProvider extends CredentialsProvider {
/** Install this implementation as the default. */ /**
* Install this implementation as the default.
*/
public static void install() { public static void install() {
final AwtCredentialsProvider c = new AwtCredentialsProvider(); final AwtCredentialsProvider c = new AwtCredentialsProvider();
CredentialsProvider cp = new ChainingCredentialsProvider( CredentialsProvider cp = new ChainingCredentialsProvider(
@ -72,11 +76,13 @@ public static void install() {
CredentialsProvider.setDefault(cp); CredentialsProvider.setDefault(cp);
} }
/** {@inheritDoc} */
@Override @Override
public boolean isInteractive() { public boolean isInteractive() {
return true; return true;
} }
/** {@inheritDoc} */
@Override @Override
public boolean supports(CredentialItem... items) { public boolean supports(CredentialItem... items) {
for (CredentialItem i : items) { for (CredentialItem i : items) {
@ -98,6 +104,7 @@ else if (i instanceof CredentialItem.InformationalMessage)
return true; return true;
} }
/** {@inheritDoc} */
@Override @Override
public boolean get(URIish uri, CredentialItem... items) public boolean get(URIish uri, CredentialItem... items)
throws UnsupportedCredentialItem { throws UnsupportedCredentialItem {

View File

@ -81,7 +81,9 @@ public class CommitGraphPane extends JTable {
private final SwingCommitList allCommits; private final SwingCommitList allCommits;
/** Create a new empty panel. */ /**
* Create a new empty panel.
*/
public CommitGraphPane() { public CommitGraphPane() {
allCommits = new SwingCommitList(); allCommits = new SwingCommitList();
configureHeader(); configureHeader();
@ -110,6 +112,7 @@ public PlotCommitList getCommitList() {
return allCommits; return allCommits;
} }
/** {@inheritDoc} */
@Override @Override
public void setModel(final TableModel dataModel) { public void setModel(final TableModel dataModel) {
if (dataModel != null && !(dataModel instanceof CommitTableModel)) if (dataModel != null && !(dataModel instanceof CommitTableModel))
@ -117,6 +120,7 @@ public void setModel(final TableModel dataModel) {
super.setModel(dataModel); super.setModel(dataModel);
} }
/** {@inheritDoc} */
@Override @Override
protected TableModel createDefaultDataModel() { protected TableModel createDefaultDataModel() {
return new CommitTableModel(); return new CommitTableModel();

View File

@ -67,6 +67,7 @@ private void repackColors() {
colors.add(Color.orange); colors.add(Color.orange);
} }
/** {@inheritDoc} */
@Override @Override
protected SwingLane createLane() { protected SwingLane createLane() {
final SwingLane lane = new SwingLane(); final SwingLane lane = new SwingLane();
@ -76,6 +77,7 @@ protected SwingLane createLane() {
return lane; return lane;
} }
/** {@inheritDoc} */
@Override @Override
protected void recycleLane(final SwingLane lane) { protected void recycleLane(final SwingLane lane) {
colors.add(lane.color); colors.add(lane.color);

View File

@ -52,6 +52,8 @@
public class UIText extends TranslationBundle { public class UIText extends TranslationBundle {
/** /**
* Get an instance of this translation bundle.
*
* @return an instance of this translation bundle * @return an instance of this translation bundle
*/ */
public static UIText get() { public static UIText get() {