Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix some documentation error of issue 475 #9983

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ Note that this project **does not** adhere to [Semantic Versioning](http://semve
- In case the library contains empty entries, they are not written to disk. [#8645](https://github.com/JabRef/jabref/issues/8645)
- The formatter `remove_unicode_ligatures` is now called `replace_unicode_ligatures`. [#9890](https://github.com/JabRef/jabref/pull/9890)
- We improved the error message when no terminal was found [#9607](https://github.com/JabRef/jabref/issues/9607)
- We changed and removed some illegal tags in javadoc. [koppor#475](https://github.com/koppor/jabref/issues/475)

### Fixed

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Copyright (c) 2014, 2015, ControlsFX
* All rights reserved.
*
* <p>
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
Expand All @@ -12,7 +12,7 @@
* * Neither the name of ControlsFX, any associated website, nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* <p>
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Expand Down Expand Up @@ -41,6 +41,8 @@
* Represents a binding between a text input control and an auto-completion popup
* This class is a slightly modified version of {@link impl.org.controlsfx.autocompletion.AutoCompletionTextFieldBinding}
* that works with general text input controls instead of just text fields.
*
* @param <T> Description of T
*/
public class AutoCompletionTextInputBinding<T> extends AutoCompletionBinding<T> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
public class TextInputControlBehavior {

/**
* @implNote taken from {@link com.sun.javafx.scene.control.behavior.TextFieldBehavior#contextMenuRequested(javafx.scene.input.ContextMenuEvent)}
* taken from {@link com.sun.javafx.scene.control.behavior.TextFieldBehavior#contextMenuRequested(javafx.scene.input.ContextMenuEvent)}
*/
public static void showContextMenu(TextField textField, ContextMenu contextMenu, ContextMenuEvent e) {
double screenX = e.getScreenX();
Expand Down Expand Up @@ -81,7 +81,7 @@ public static void showContextMenu(TextField textField, ContextMenu contextMenu,
}

/**
* @implNote taken from {@link com.sun.javafx.scene.control.behavior.TextAreaBehavior#contextMenuRequested(javafx.scene.input.ContextMenuEvent)}
* taken from {@link com.sun.javafx.scene.control.behavior.TextAreaBehavior#contextMenuRequested(javafx.scene.input.ContextMenuEvent)}
*/
public static void showContextMenu(TextArea textArea, ContextMenu contextMenu, ContextMenuEvent e) {
double screenX = e.getScreenX();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public static Optional<MetaDataDiff> compare(MetaData originalMetaData, MetaData
}

/**
* @implNote Should be kept in sync with {@link MetaData#equals(Object)}
* Should be kept in sync with {@link MetaData#equals(Object)}
*/
public EnumSet<Difference> getDifferences(PreferencesService preferences) {
EnumSet<Difference> changes = EnumSet.noneOf(Difference.class);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package org.jabref.logic.importer;

/**
* Should be thrown when you encounter a http status code error >= 400 and < 500
* Should be thrown when you encounter an HTTP status code error &gt;= 400 and &lt; 500.
*/
public class FetcherClientException extends FetcherException {

Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/jabref/logic/importer/fetcher/IEEE.java
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@
import org.slf4j.LoggerFactory;

/**
* Class for finding PDF URLs for entries on IEEE
* Will first look for URLs of the type <code>https://ieeexplore.ieee.org/stamp/stamp.jsp?[tp=&]arnumber=...</code>
* If not found, will resolve the DOI, if it starts with 10.1109, and try to find a similar link on the HTML page
* Class for finding PDF URLs for entries on IEEE.
* Will first look for URLs of the type <code>https://ieeexplore.ieee.org/stamp/stamp.jsp?[tp=&amp;]arnumber=...</code>.
* If not found, will resolve the DOI, if it starts with 10.1109, and try to find a similar link on the HTML page.
*
* @see <a href="https://developer.ieee.org/docs">API documentation</a>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import org.jabref.model.entry.types.StandardEntryType;

/**
* @implNote implemented by reverse-engineering <a href="https://github.com/SeerLabs/CiteSeerX/blob/4df28a98083be2829ec4c56ebbac09eb7772d379/src/java/edu/psu/citeseerx/domain/BiblioTransformer.java#L155-L249">the implementation by CiteSeerX</a>
* implemented by reverse-engineering <a href="https://github.com/SeerLabs/CiteSeerX/blob/4df28a98083be2829ec4c56ebbac09eb7772d379/src/java/edu/psu/citeseerx/domain/BiblioTransformer.java#L155-L249">the implementation by CiteSeerX</a>
*/
public class CoinsParser implements Parser {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,10 @@
* Importer for the ISI Web of Science, INSPEC and Medline format.
* <p>
* Documentation about ISI WOS format:
* <p>
* </p>
* <ul>
* <li>https://web.archive.org/web/20131031052339/http://wos.isitrial.com/help/helpprn.html</li>
* </ul>
* <p>
* <ul>
* <li>Deal with capitalization correctly</li>
* </ul>
Expand Down