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

Fixed javadoc tags #5419

Merged
merged 1 commit into from
Feb 3, 2023
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public interface NbModuleProvider {

/** Returns a relative path to a project's test source directory.
* @return relative path to test sources..
* @Since 1.56
* @since 1.56
*/
String getTestSourceDirectoryPath();
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* Manages a module's lifecycle. Remember that an installer is optional and
* often not needed at all.
*
* @auther Peter Williams
* @author Peter Williams
*/
public class Installer extends ModuleInstall {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
*
* based on UndeployModuleCookie
* @author Michal Mocnak
* @auther Peter Williams
* @author Peter Williams
*/
public interface DisableModulesCookie extends Node.Cookie {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
*
* based on UndeployModuleCookie
* @author Michal Mocnak
* @auther Peter Williams
* @author Peter Williams
*/
public interface EnableModulesCookie extends Node.Cookie {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
*
* @author Michal Mocnak
* @auther Peter Williams
* @author Peter Williams
*/
public interface UndeployModuleCookie extends Node.Cookie {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

/**
*
* @auther Peter Williams
* @author Peter Williams
*/
public interface UnregisterResourceCookie extends Node.Cookie {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ private void toolChar(final char c) {
* Get value of user <code>String</code> read
* from <code>admin-keyfile</code>.
* <p/>
* @rerurn Value of user <code>String</code>.
* @return Value of user <code>String</code>.
*/
private String getUser() {
return user.toString();
Expand All @@ -332,7 +332,7 @@ private String getUser() {
* Get value of password hash <code>String</code> read
* from <code>admin-keyfile</code>.
* <p/>
* @rerurn Value of password hash <code>String</code>.
* @return Value of password hash <code>String</code>.
*/
private String getPasswordHash() {
return hash.toString();
Expand All @@ -342,7 +342,7 @@ private String getPasswordHash() {
* Get value of tool <code>String</code> read
* from <code>admin-keyfile</code>.
* <p/>
* @rerurn Value of tool <code>String</code>.
* @return Value of tool <code>String</code>.
*/
private String getTool() {
return tool.toString();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
/**
*
* @author Ludovic Champenois
* @auther Peter Williams
* @author Peter Williams
* @author vince kraemer
*/
public class Hk2StartServer extends StartServer implements ProgressObject {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
*
* @author Petr Hrebejk
* @author Jesse Glick
* @authos Martin Adamek
* @author Martin Adamek
*/
public class MultiTargetChooserPanelGUI extends javax.swing.JPanel implements ActionListener, DocumentListener {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
*
* @author Chris Webster
* @author Martin Adamek
* @Petr Slechta
* @author Petr Slechta
*/
public class CallEjbPanel extends javax.swing.JPanel {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

/**
* @author pfiala
* @auther Peter Williams
* @author Peter Williams
*/
public class SunWebJspConfigPropertyNode extends BaseSectionNode {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
/**
*
* @author vkraemer
* @auther Peter Williams
* @author Peter Williams
*/
public class Utils implements org.netbeans.modules.j2ee.sun.share.Constants {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* Manages a module's lifecycle. Remember that an installer is optional and
* often not needed at all.
*
* @auther Peter Williams
* @author Peter Williams
*/
public class Installer extends ModuleInstall {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
*
* based on UndeployModuleCookie
* @author Michal Mocnak
* @auther Peter Williams
* @author Peter Williams
*/
public interface DisableModulesCookie extends Node.Cookie {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
*
* based on UndeployModuleCookie
* @author Michal Mocnak
* @auther Peter Williams
* @author Peter Williams
*/
public interface EnableModulesCookie extends Node.Cookie {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
*
* @author Michal Mocnak
* @auther Peter Williams
* @author Peter Williams
*/
public interface UndeployModuleCookie extends Node.Cookie {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

/**
*
* @auther Peter Williams
* @author Peter Williams
*/
public interface UnregisterResourceCookie extends Node.Cookie {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ private void toolChar(final char c) {
* Get value of user <code>String</code> read
* from <code>admin-keyfile</code>.
* <p/>
* @rerurn Value of user <code>String</code>.
* @return Value of user <code>String</code>.
*/
private String getUser() {
return user.toString();
Expand All @@ -332,7 +332,7 @@ private String getUser() {
* Get value of password hash <code>String</code> read
* from <code>admin-keyfile</code>.
* <p/>
* @rerurn Value of password hash <code>String</code>.
* @return Value of password hash <code>String</code>.
*/
private String getPasswordHash() {
return hash.toString();
Expand All @@ -342,7 +342,7 @@ private String getPasswordHash() {
* Get value of tool <code>String</code> read
* from <code>admin-keyfile</code>.
* <p/>
* @rerurn Value of tool <code>String</code>.
* @return Value of tool <code>String</code>.
*/
private String getTool() {
return tool.toString();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
/**
*
* @author Ludovic Champenois
* @auther Peter Williams
* @author Peter Williams
* @author vince kraemer
*/
public class Hk2StartServer extends StartServer implements ProgressObject {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ public static void createUser(File tomcatUsersFile, String username, String pass
*
* @param tomcatUsersFile tomcat-users.xml file.
*
* @retun true if the user exists and has the "manager" role, false otherwise.
* @return true if the user exists and has the "manager" role, false otherwise.
*
* @throws IOException if the file does not exist or an error occurs during
* parsing it.
Expand Down Expand Up @@ -156,7 +156,7 @@ public static boolean hasManagerRole(TomcatVersion version,
*
* @param tomcatUsersFile tomcat-users.xml file.
*
* @retun true if the user exists, false otherwise.
* @return true if the user exists, false otherwise.
*
* @throws IOException if the file does not exist or an error occurs during
* parsing it.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ public Parser getParser() {
* NOTE: Code folding doesn't work until you enable code folding for your
* editor kit; see GsfEditorKitFactory's reference to CODE_FOLDING_ENABLE for
* an example.
* @wasdeprecated This function is not called anymore. You
* @deprecated This function is not called anymore. You
* MUST register the custom editor kit attribute via the layer! That's because
* currently, finding out whether a module has supplies a custom editor
* kit must be done early during startup (in the file type recognition code,
Expand All @@ -120,6 +120,7 @@ public Parser getParser() {
* (including classes they reference) at startup. Hopefully a
* better solution will be provided soon.
*/
@Deprecated
public boolean isUsingCustomEditorKit() {
return false;
}
Expand Down Expand Up @@ -195,14 +196,15 @@ public EmbeddingIndexerFactory getIndexerFactory() {
*
* @return true iff this language configuration provides a
* structure scanner.
* @wasdeprecated This function is not called anymore. You
* @deprecated This function is not called anymore. You
* MUST register structure scanners via the layer! That's because
* currently, finding out whether a module has a structure scanner
* has to be done very early (before any language types are opened)
* and we don't want to force loading all language configurations
* (including classes they reference) at startup. Hopefully a
* better solution will be provided soon.
*/
@Deprecated
public boolean hasStructureScanner() {
return false;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ public Preferences getPreferences() {
* in order to seprate the project-dependent implementation of code style preferences
* storage from the rest of the editor infrastructure.
*
* @Since 1.18
* @since 1.18
*/
public static interface Provider {
Preferences forFile(FileObject file, String mimeType);
Expand Down
2 changes: 1 addition & 1 deletion ide/editor.lib/src/org/netbeans/editor/EditorUI.java
Original file line number Diff line number Diff line change
Expand Up @@ -719,7 +719,7 @@ public Coloring getDefaultColoring() {
*
* @param coloringName The name of the coloring to find.
*
* @retrun The coloring or <code>null</code> if there is no coloring with the
* @return The coloring or <code>null</code> if there is no coloring with the
* requested name.
* @deprecated Use Editor Settings API instead.
*/
Expand Down
3 changes: 2 additions & 1 deletion ide/editor.lib/src/org/netbeans/editor/JumpList.java
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,9 @@ public static boolean hasNext() {

/**
* @return Unspecified string.
* @deprecate Should have never been public.
* @deprecated Should have never been public.
*/
@Deprecated
public static String dump() {
StringBuilder sb = new StringBuilder();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ protected void appendString(String s) {
* called with the full range of keywords and offset equal to zero.
* It recursively calls itself to scan the subgroups.
* @param indFrom index in kwds[] where the subgroup of keywords starts
* @pararm indTo index in kwds[] where the subgroup of keywords ends
* @param indTo index in kwds[] where the subgroup of keywords ends
* @param offset current horizontal offset. It's incremented as the subgroups
* are recognized. All the characters prior to offset index are the same
* in all keywords in the group.
Expand Down
12 changes: 6 additions & 6 deletions ide/editor.lib/src/org/netbeans/editor/ext/ToolTipSupport.java
Original file line number Diff line number Diff line change
Expand Up @@ -181,16 +181,16 @@ public class ToolTipSupport {

private static final MouseListener NO_OP_MOUSE_LISTENER = new MouseAdapter() {};

/** @Since 2.10 */
/** @since 2.10 */
public static final int FLAG_HIDE_ON_MOUSE_MOVE = 1;
/** @Since 2.10 */
/** @since 2.10 */
public static final int FLAG_HIDE_ON_TIMER = 2;
/** @Since 2.10 */
/** @since 2.10 */
public static final int FLAG_PERMANENT = 4;

/** @Since 2.10 */
/** @since 2.10 */
public static final int FLAGS_LIGHTWEIGHT_TOOLTIP = FLAG_HIDE_ON_MOUSE_MOVE | FLAG_HIDE_ON_TIMER;
/** @Since 2.10 */
/** @since 2.10 */
public static final int FLAGS_HEAVYWEIGHT_TOOLTIP = FLAG_PERMANENT;

private static final String ELIPSIS = "..."; //NOI18N
Expand Down Expand Up @@ -297,7 +297,7 @@ public void setToolTip(
}

/**
* @Since 2.10
* @since 2.10
*/
public void setToolTip(
JComponent toolTip,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ public Set<String> getProfilesDisplayNames() {
* Gets description for a profile by its name.
*
* @param displayName The display name of the profile to get the description for.
* @retutn The profile's description or <code>null</code> if there is no
* @return The profile's description or <code>null</code> if there is no
* profile with the display name.
*/
public ProfileDescription getProfileByDisplayName(String displayName) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,15 @@ public static synchronized ParserManager get (Document doc) {
/**
* Returns state of parser.
*
* @retrun a state of parser
* @return a state of parser
*/
public abstract State getState ();

/**
* Returns AST tree root node.
*
* @throws in the case of errors in document
* @retrun AST tree root node
* @return AST tree root node
*/
public abstract ASTNode getAST () throws ParseException;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ public final void stopSearch() {
/**
* Does search.
*
* @throw RuntimeException USER level annotated runtime exception
* @throws RuntimeException USER level annotated runtime exception
* on low memory condition (instead of OutOfMemoryError)
*/
public void search() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

/**
*
* @Alex Petrov (Alexey.Petrov@Sun.com)
* @author Alex Petrov (Alexey.Petrov@Sun.com)
*/
public class EndTagResultItem extends CompletionResultItem {
private static final Logger _logger = Logger.getLogger(EndTagResultItem.class.getName());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

/**
*
* @Alex Petrov (Alexey.Petrov@Sun.com)
* @author Alex Petrov (Alexey.Petrov@Sun.com)
*/
public class TagLastCharResultItem extends CompletionResultItem {
private static final Logger _logger = Logger.getLogger(TagLastCharResultItem.class.getName());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
import org.w3c.dom.Element;

/**
* @auther Nam Nguyen
* @author Nam Nguyen
* @author Vidhya Narayanan
*/
public class AnnotationImplTest extends TestCase {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ public static String replaceCharsWithEntityStrings(String value) {
* @param doc
* @param startOffset
* @param endOffset
* @throw IllegalArgumentException if the document implementation is not compatible
* @throws IllegalArgumentException if the document implementation is not compatible
*/
public static void reformat(final LineDocument doc, final int startOffset, final int endOffset) {
final XMLLexerFormatter formatter = new XMLLexerFormatter(null);
Expand Down
Loading