hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update patterns in the incompatibilities guide.

Browse Source
This commit is contained in:
Sergey Patrikeev 2019-03-25 11:12:05 +03:00 committed by GitHub
parent a7f156ec61
commit 9034b7b0f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
reference_guide/api_changes_list.md
View File

@ -18,26 +18,28 @@ The following problem patterns are supported:
<class name> class removed
<class name> renamed to <new class name>
<class name>.<method name> method removed
<class name>.<method name> method return type changed from <before> to <after>
<class name>.<method name> method parameter <type> removed
<class name>.<method name> method parameter type changed from <before> to <after>
<class name>.<method name> method visibility changed from <before> to <after>
<class name>.<method name> method marked final
<class name>.<method name>(<human-readable parametes>) method removed
<class name>.<method name>(<human-readable parametes>) method return type changed from <before> to <after>
<class name>.<method name>(<human-readable parametes>) method parameter <type> removed
<class name>.<method name>(<human-readable parametes>) method parameter type changed from <before> to <after>
<class name>.<method name>(<human-readable parametes>) method visibility changed from <before> to <after>
<class name>.<method name>(<human-readable parametes>) method marked final
<class name> constructor removed
<class name> constructor parameter <type> removed
<class name> constructor parameter type changed from <before> to <after>
<class name> constructor visibility changed from <before> to <after>
<class name>(<human-readable parametes>) constructor removed
<class name>(<human-readable parametes>) constructor parameter <type> removed
<class name>(<human-readable parametes>) constructor parameter type changed from <before> to <after>
<class name>(<human-readable parametes>) constructor visibility changed from <before> to <after>
<class name>.<field name> field removed
<class name>.<field name> field type changed from <before> to <after>
<class name>.<field name> field visibility changed from <before> to <after>
<class name>.<method name> abstract method added
<class name>.<method name>(<human-readable parametes>) abstract method added
<class name> class moved to package <package name>
where <class name> is a fully-qualified name of the class, e.g. com.intellij.openapi.actionSystem.AnAction$InnerClass.
<method name> is the exact method's name. Note that constructors have dedicated patterns.
<human-readable parametes> is a string representing parameters, which are not necessarily fully qualified. They do not affect the parser. For example, instead of (java.lang.Object, java.util.List, int) you are free to write just (Object, List<String>, int).
NOTE: If a change you're trying to document doesn't match any of the above patterns, fill in a ticket in the YouTrack.
An example of a ticket is https://youtrack.jetbrains.com/issue/PR-1218. Until supported, you may document the change as you prefer, and I will correct it later.