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

sdk_code_guidelines.md: add note about README for code samples (#548)

Browse Source
This commit is contained in:
Jakub Chrzanowski 2021-09-08 11:51:49 +02:00 committed by GitHub
parent 90142280ea
commit 934931f37d
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
SAMPLE_README.md Normal file
View File

@ -0,0 +1,40 @@
# Sample [![JetBrains IntelliJ Platform SDK Docs](https://jb.gg/badges/docs.svg)][docs]
*Reference: [Sample Article in IntelliJ SDK Docs][docs:sampleArticle]*
## Quickstart
The Sample implements `com.intellij.sample` Extension Point, which should be explained properly in this Quickstart section.
### Extension Points
| Name | Implementation | Extension Point Class |
| --------------------- | ------------------------------------------------- | --------------------- |
| `com.intellij.sample` | [SampleExtensionPoint][file:SampleExtensionPoint] | `ExtensionPoint` |
*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]*
### Actions
| ID | Implementation | Base Action Class |
| -------------------------------------- | --------------------------------- | ----------------- |
| `org.intellij.sdk.action.SampleAction` | [SampleAction][file:SampleAction] | `AnAction` |
*Reference: [Action System in IntelliJ SDK Docs][docs:actions]*
### Listeners
| Name | Implementation | Listener Class |
| -------- | ------------------------------------- | -------------- |
| listener | [SampleListener][file:SampleListener] | `Listener` |
*Reference: [Plugin Listeners in IntelliJ SDK Docs][docs:listeners]*
[docs]: https://plugins.jetbrains.com/docs/intellij/
[docs:actions]: https://plugins.jetbrains.com/docs/intellij/basic-action-system.html
[docs:ep]: https://plugins.jetbrains.com/docs/intellij/plugin-extensions.html
[docs:listeners]: https://plugins.jetbrains.com/docs/intellij/plugin-listeners.html
[docs:sampleArticle]: https://plugins.jetbrains.com/docs/intellij/sampleArticle.html
[file:SampleExtensionPoint]: ./src/main/java/org/intellij/sdk/sample/SampleExtensionPoint.java
[file:SampleAction]: ./src/main/java/org/intellij/sdk/sample/SampleAction.java
[file:SampleListener]: ./src/main/java/org/intellij/sdk/sample/SampleListener.java