diff --git a/topics/appendix/api_internal/api_internal.md b/topics/appendix/api_internal/api_internal.md index 795edccf8..7a041693d 100644 --- a/topics/appendix/api_internal/api_internal.md +++ b/topics/appendix/api_internal/api_internal.md @@ -2,6 +2,8 @@ +Lists private API annotated with ApiStatus.Internal and corresponding replacement. + This page lists commonly used API annotated with [`org.jetbrains.annotations.ApiStatus.Internal`](https://github.com/JetBrains/java-annotations/blob/master/common/src/main/java/org/jetbrains/annotations/ApiStatus.java) which indicates it's _private API_ and must not be used outside of IntelliJ Platform itself: > _ApiStatus.Internal Javadoc_: diff --git a/topics/appendix/resources/explore_api.md b/topics/appendix/resources/explore_api.md index 2634755d6..8ff86ba84 100644 --- a/topics/appendix/resources/explore_api.md +++ b/topics/appendix/resources/explore_api.md @@ -2,6 +2,8 @@ +Strategies and tools for exploring the API. + Sometimes it can be challenging to implement plugin features for the IntelliJ Platform, especially when you've hit a roadblock and you're unsure how to move forward. This usually happens in two situations: diff --git a/topics/appendix/resources/learning_resources.md b/topics/appendix/resources/learning_resources.md index e761174df..fdbec9873 100644 --- a/topics/appendix/resources/learning_resources.md +++ b/topics/appendix/resources/learning_resources.md @@ -2,7 +2,7 @@ -Links to articles and webinars about plugin development +Links to articles and webinars about plugin development. > Follow [JBPlatform](https://twitter.com/JBPlatform/) on Twitter and visit [JetBrains Platform Blog](https://blog.jetbrains.com/platform/) for the latest announcements. > diff --git a/topics/basics/architectural_overview/element_patterns.md b/topics/basics/architectural_overview/element_patterns.md index 4dd4797e4..5c24a6d26 100644 --- a/topics/basics/architectural_overview/element_patterns.md +++ b/topics/basics/architectural_overview/element_patterns.md @@ -2,7 +2,10 @@ + +

Element patterns provide a generic way to specify conditions on objects. +

Plugin authors use them to check whether PSI elements match a particular structure. Just as regular expressions for strings test whether a (sub-)string matches a particular pattern, element patterns are used to put conditions on the nested structure of PSI elements. Their two main applications inside the IntelliJ Platform are: diff --git a/topics/basics/plugin_structure/plugin_extensions.md b/topics/basics/plugin_structure/plugin_extensions.md index ac9893a3f..d53999448 100644 --- a/topics/basics/plugin_structure/plugin_extensions.md +++ b/topics/basics/plugin_structure/plugin_extensions.md @@ -2,6 +2,8 @@ +Extensions are the most common way of customizing functionality in the IDE. + _Extensions_ are the most common way for a plugin to extend the IntelliJ Platform's functionality in a way that is not as straightforward as adding an action to a menu or toolbar. The following are some of the most common tasks accomplished using extensions: diff --git a/topics/basics/plugin_structure/plugin_listeners.md b/topics/basics/plugin_structure/plugin_listeners.md index 36ca97b6e..96a51c64f 100644 --- a/topics/basics/plugin_structure/plugin_listeners.md +++ b/topics/basics/plugin_structure/plugin_listeners.md @@ -2,6 +2,8 @@ +Listeners allow subscription to application and project events. + _Listeners_ allow plugins to declaratively subscribe to events delivered through the message bus (see [Messaging infrastructure](messaging_infrastructure.md) for details). Listener implementations must be stateless and may not implement life-cycle (e.g., `Disposable`). diff --git a/topics/reference_guide/custom_language_support.md b/topics/reference_guide/custom_language_support.md index 08b0f64f6..3aa57f0f0 100644 --- a/topics/reference_guide/custom_language_support.md +++ b/topics/reference_guide/custom_language_support.md @@ -2,6 +2,8 @@ +Supporting custom languages overview. + IntelliJ Platform is a powerful platform for building development tools targeting *any* language. Most of the IDE features consist of language-independent (provided by the platform) and language-specific parts. Supporting a particular feature for a new language can be achieved with a small amount of effort: diff --git a/topics/reference_guide/custom_language_support/additional_minor_features.md b/topics/reference_guide/custom_language_support/additional_minor_features.md index c74f71e36..32dd36cb2 100644 --- a/topics/reference_guide/custom_language_support/additional_minor_features.md +++ b/topics/reference_guide/custom_language_support/additional_minor_features.md @@ -2,6 +2,8 @@ +Additional minor features for custom languages. + A number of minor features are listed in the following format: _EP: `fully.qualified.extensionPointName`_ - Extension Point Name (must be specified in plugin.xml) diff --git a/topics/reference_guide/settings_guide.md b/topics/reference_guide/settings_guide.md index ee6e98b56..e6a175ade 100644 --- a/topics/reference_guide/settings_guide.md +++ b/topics/reference_guide/settings_guide.md @@ -2,6 +2,8 @@ +Adding entries in Settings/Preferences. + _Settings_ persistently store states that control the behavior and appearance of IntelliJ Platform-based IDEs. On this page, the term "Settings" means the same as "Preferences" on some platforms. diff --git a/topics/tutorials/custom_language_support/custom_language_support_tutorial.md b/topics/tutorials/custom_language_support/custom_language_support_tutorial.md index c0748a4a9..3347f0617 100644 --- a/topics/tutorials/custom_language_support/custom_language_support_tutorial.md +++ b/topics/tutorials/custom_language_support/custom_language_support_tutorial.md @@ -2,6 +2,8 @@ +Tutorial for creating a .properties-like custom language. + In this tutorial we will add support for a [.properties](https://en.wikipedia.org/wiki/.properties) language and its usages within Java code. > IntelliJ Platform support for custom languages is discussed in more depth in the [Custom Language Support](custom_language_support.md) section.