diff --git a/topics/appendix/verifying_plugin_compatibility.md b/topics/appendix/verifying_plugin_compatibility.md index b99fc0947..80094120b 100644 --- a/topics/appendix/verifying_plugin_compatibility.md +++ b/topics/appendix/verifying_plugin_compatibility.md @@ -1,7 +1,7 @@ -# Verifying Plugin Compatibility - +# Verifying Plugin Compatibility + Tooling for ensuring compatibility. Please see [](api_changes_list.md) for known breaking changes. @@ -23,7 +23,7 @@ In other cases, [intellij-plugin-verifier](https://github.com/JetBrains/intellij ## IDE Support -The status of an API is marked using various annotations defined in [`ApiStatus`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java), please see their javadoc for more details. +The status of an API is marked using various annotations defined in [`ApiStatus`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java), please see their Javadoc for more details. Use highlighting available via dedicated [IDE inspections](https://www.jetbrains.com/help/idea/code-inspection.html) as noted below to prevent problems as early as possible. ### Unstable API diff --git a/topics/basics/indexing_and_psi_stubs.md b/topics/basics/indexing_and_psi_stubs.md index 4cde62b72..9492fec65 100644 --- a/topics/basics/indexing_and_psi_stubs.md +++ b/topics/basics/indexing_and_psi_stubs.md @@ -29,11 +29,11 @@ Therefore, custom language plugin developers typically use stub indexes in their Indexing is a potentially lengthy process. It's performed in the background, and during this time, IDE features are restricted to the ones that don't require index: basic text editing, version control, etc. This restriction is managed by [`DumbService`](%gh-ic%/platform/core-api/src/com/intellij/openapi/project/DumbService.java). -Violations are reported via [`IndexNotReadyException`](%gh-ic%/platform/core-api/src/com/intellij/openapi/project/IndexNotReadyException.java), please see its javadoc on how to adapt callers. +Violations are reported via [`IndexNotReadyException`](%gh-ic%/platform/core-api/src/com/intellij/openapi/project/IndexNotReadyException.java) - see its Javadoc for the information on how to adapt callers. `DumbService` provides API to query whether the IDE is currently in "dumb" mode (where index access is not allowed) or "smart" mode (with all index built and ready to use). It also provides ways of delaying code execution until indexes are ready. -Please see its JavaDoc for more details. +See its Javadoc for more details. ## Gists diff --git a/topics/basics/indexing_and_psi_stubs/file_based_indexes.md b/topics/basics/indexing_and_psi_stubs/file_based_indexes.md index d7a6d2f94..1128e7ae1 100644 --- a/topics/basics/indexing_and_psi_stubs/file_based_indexes.md +++ b/topics/basics/indexing_and_psi_stubs/file_based_indexes.md @@ -71,7 +71,7 @@ Access to file-based indexes is performed through the [`FileBasedIndex`](%gh-ic% The following primary operations are supported: * `getAllKeys()` and `processAllKeys()` allow obtaining the list of all keys found in files, which are a part of the specified project. - To optimize performance, consider returning `true` from `FileBasedIndexExtension.traceKeyHashToVirtualFileMapping()` (see javadoc for details). + To optimize performance, consider returning `true` from `FileBasedIndexExtension.traceKeyHashToVirtualFileMapping()` (see its Javadoc for details). > The returned data is guaranteed to contain all keys found in up-to-date project content, but may also include additional keys not currently found in the project. > diff --git a/topics/basics/intellij_coding_guidelines.md b/topics/basics/intellij_coding_guidelines.md index 30039302f..9d32cdbce 100644 --- a/topics/basics/intellij_coding_guidelines.md +++ b/topics/basics/intellij_coding_guidelines.md @@ -36,10 +36,10 @@ The easiest way to follow our code formatting guidelines is to reformat your cod The IntelliJ IDEA Community Edition project includes a shared inspection profile. We strongly recommend making sure that the code you submit does not contain any warnings highlighted by the inspections configured in that inspection profile. -## JavaDoc Comments +## Javadoc Comments -If your code adds new OpenAPI interfaces, classes, methods, or extension points, you must provide JavaDoc comments describing the parameters and intended usage of the APIs. -Providing JavaDoc or other comments for other parts of the code is a good idea but isn't required. +If your code adds new OpenAPI interfaces, classes, methods, or extension points, you must provide Javadoc comments describing the parameters and intended usage of the APIs. +Providing Javadoc or other comments for other parts of the code is a good idea but isn't required. ## Commits diff --git a/topics/basics/testing_plugins/testing_faq.md b/topics/basics/testing_plugins/testing_faq.md index e9f4ab2b1..87c1e566b 100644 --- a/topics/basics/testing_plugins/testing_faq.md +++ b/topics/basics/testing_plugins/testing_faq.md @@ -1,6 +1,6 @@ -# Testing FAQ + - +# Testing FAQ Common questions and issues for testing plugins. @@ -101,7 +101,7 @@ Annotate with [`org.jetbrains.annotations.TestOnly`](https://github.com/JetBrain ### How to run tests for all files in a directory? -Use [`FileBasedTestCaseHelper`](%gh-ic%/platform/testFramework/src/com/intellij/testFramework/FileBasedTestCaseHelper.java), please see its javadoc for instructions. +Use [`FileBasedTestCaseHelper`](%gh-ic%/platform/testFramework/src/com/intellij/testFramework/FileBasedTestCaseHelper.java), please see its Javadoc for instructions. ### How to modify setup on a per-test basis? diff --git a/topics/intro/sdk_code_guidelines.md b/topics/intro/sdk_code_guidelines.md index 923cdcc3f..fac53108b 100644 --- a/topics/intro/sdk_code_guidelines.md +++ b/topics/intro/sdk_code_guidelines.md @@ -21,7 +21,7 @@ Keep the following considerations in mind while authoring an SDK code sample: Use error checking where it is necessary to make a point about an implementation pitfall. * Keep implementations as simple as possible, but use the full features of the IntelliJ Platform, programming language, and libraries. * Use meaningful names for interfaces, classes, fields, methods, and extension points. - * Write instructional JavaDoc comments. + * Write instructional Javadoc comments. * Code samples replace lots of documentation. * Aim for two levels of SDK samples: * A _basic_ sample is focused on a particular subject by demonstrating a limited area of the IntelliJ Platform. diff --git a/topics/products/idea/spring_api.md b/topics/products/idea/spring_api.md index 8243d7db8..9d754480c 100644 --- a/topics/products/idea/spring_api.md +++ b/topics/products/idea/spring_api.md @@ -116,7 +116,7 @@ All support for XML-based Spring configuration files is provided via [DOM-API](x See `com.intellij.spring.customNamespaces` EP, registered namespace-key must match the one registered with your DOM elements via `@Namespace`. Register available elements via standard `DomExtender` EP or `com.intellij.spring.dom.SpringCustomNamespaces#registerExtensions` (Version 14). -Please pay attention to `getModelVersion` and `getStubVersion` (see javadoc). +Please pay attention to `getModelVersion` and `getStubVersion` (see Javadoc). #### Add Reference to Spring Bean in DomElement Use the following template: diff --git a/topics/reference_guide/custom_language_support.md b/topics/reference_guide/custom_language_support.md index 2b45665c4..b74e8c2f6 100644 --- a/topics/reference_guide/custom_language_support.md +++ b/topics/reference_guide/custom_language_support.md @@ -12,7 +12,7 @@ a plugin must implement only the language-specific part. ## Reference This part of the documentation explains the main concepts of the *Language API* and guides you through the sequence of steps that are usually required to develop a custom language plugin. -You can obtain additional information about the *Language API* from the JavaDoc comments for the *Language API* classes and from the Properties language support source code, which is part of the [IntelliJ IDEA Community Edition](https://github.com/JetBrains/intellij-community) source code. +You can obtain additional information about the *Language API* from the Javadoc comments for the *Language API* classes and from the Properties language support source code, which is part of the [IntelliJ IDEA Community Edition](https://github.com/JetBrains/intellij-community) source code. ## Tutorial diff --git a/topics/reference_guide/custom_language_support/code_completion.md b/topics/reference_guide/custom_language_support/code_completion.md index 00eab8d9b..53ab081d2 100644 --- a/topics/reference_guide/custom_language_support/code_completion.md +++ b/topics/reference_guide/custom_language_support/code_completion.md @@ -1,7 +1,7 @@ -# Code Completion - +# Code Completion + Implementing context-aware code completion in custom languages. @@ -39,7 +39,7 @@ To provide completion variants by a `PsiSymbolReference` implement Implementing the [`CompletionContributor`](%gh-ic%/platform/analysis-api/src/com/intellij/codeInsight/completion/CompletionContributor.java) interface gives you the greatest control over the operation of code completion for your language. Register in `com.intellij.completion.contributor` extension point and specify `language` attribute (unless it works on any supported language). -> Note that the JavaDoc of that class contains a detailed FAQ for implementing code completion. +> Note that the Javadoc of that class contains a detailed FAQ for implementing code completion. > {style="note"} diff --git a/topics/reference_guide/custom_language_support/code_formatting.md b/topics/reference_guide/custom_language_support/code_formatting.md index 9ee7df42e..41c849ad5 100644 --- a/topics/reference_guide/custom_language_support/code_formatting.md +++ b/topics/reference_guide/custom_language_support/code_formatting.md @@ -1,7 +1,7 @@ -# Code Formatter - +# Code Formatter + Implementing a code formatter that aligns whitespaces according to the defined set of rules, and performs non-whitespace formatting modifications. @@ -68,7 +68,7 @@ For every block, the plugin specifies the following properties: * The _alignment_ ([`Alignment`](%gh-ic%/platform/code-style-api/src/com/intellij/formatting/Alignment.java)) specifies which blocks should be aligned with each other. If two blocks with the alignment property set to the same object instance are placed in different lines, and if the second block is the first non-whitespace block in its line, the formatter inserts whitespaces before the second block, so that it starts from the same column as the first one. -For each of these properties, several particular use settings exist, described in the JavaDoc comments for the respective classes. +For each of these properties, several particular use settings exist, described in the Javadoc comments for the respective classes. See also [`SpacingBuilder`](%gh-ic%/platform/code-style-api/src/com/intellij/formatting/SpacingBuilder.java), which aids in building rule-based configuration. An important special case in using the formatter is the smart indent performed when the user presses the `Enter` key in a source code file. @@ -110,7 +110,7 @@ To register a formatting post-processor, a plugin has to provide an implementati Allows custom languages to provide user-configurable arrangement/grouping rules for element types supported by language plugin. Rules can be refined via modifiers and name; ordering can be applied additionally. -Please see [`Rearranger`](%gh-ic%/platform/code-style-api/src/com/intellij/psi/codeStyle/arrangement/Rearranger.java) and related for JavaDoc. +Please see [`Rearranger`](%gh-ic%/platform/code-style-api/src/com/intellij/psi/codeStyle/arrangement/Rearranger.java) and related for Javadoc. ## Code Style Settings diff --git a/topics/reference_guide/text_selection.md b/topics/reference_guide/text_selection.md index a53d2588e..c6664a800 100644 --- a/topics/reference_guide/text_selection.md +++ b/topics/reference_guide/text_selection.md @@ -18,7 +18,7 @@ See also: ### Overview The two actions [Extend Selection and Shrink Selection](https://www.jetbrains.com/help/idea/working-with-source-code.html#editor_code_selection) in IntelliJ Platform IDEs let you adjust selected text based on the structure of the source code. -This makes it easy to select not only expressions, blocks, and function definitions, but also code like whole lines or tags in JavaDoc comments. +This makes it easy to select not only expressions, blocks, and function definitions, but also code like whole lines or tags in Javadoc comments. When implementing a custom language, the IntelliJ Platform provides basic implementations of this EP, allowing you to select code based on your PSI structure and to select whole lines. In many cases this is sufficient to provide a good user experience. @@ -46,7 +46,7 @@ This can be achieved by implementing this EP in the following way: Looking at other implementations can be an effective way to get a better understanding of how this EP works. To get further insight into this EP, you may want to take a look at [`DocTagSelectioner`](%gh-ic%/java/java-impl/src/com/intellij/codeInsight/editorActions/wordSelection/DocTagSelectioner.java). -It provides the ability to select tag names like `@param` in JavaDoc comments. +It provides the ability to select tag names like `@param` in Javadoc comments. Additionally, the [IntelliJ Platform Explorer](https://jb.gg/ipe?extensions=com.intellij.extendWordSelectionHandler) provides a list of open-source plugins with implementations of the `com.intellij.extendWordSelectionHandler` EP. There are also some important places in the IntelliJ Platform to add breakpoints during debugging.