# servicedoc-plugin-idea

**Repository Path**: UnlimitedBladeWorks_123/servicedoc-plugin-idea

## Basic Information

- **Project Name**: servicedoc-plugin-idea
- **Description**: servicedoc plugin for idea
- **Primary Language**: Java
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 16
- **Forks**: 0
- **Created**: 2018-12-11
- **Last Updated**: 2025-08-25

## Categories & Tags

**Categories**: idea-plugins

**Tags**: None

## README

ServiceDoc
---

* This is a plugin you can generate serviceDoc from public method.
* Please do aware **This plugin is only for IntelliJ IDEA**.
* This plugin develop for the npm model `servicedoc`, [HomePage](https://www.npmjs.com/package/servicedoc), install command `npm i servicedoc` 

## Install   
- Using IDE built-in plugin system on Windows:
  - <kbd>File</kbd> > <kbd>Settings</kbd> > <kbd>Plugins</kbd> > <kbd>Browse repositories...</kbd> > <kbd>Search for "ServiceDoc"</kbd> > <kbd>Install Plugin</kbd>
- Using IDE built-in plugin system on MacOs:
  - <kbd>Preferences</kbd> > <kbd>Settings</kbd> > <kbd>Plugins</kbd> > <kbd>Browse repositories...</kbd> > <kbd>Search for "ServiceDoc"</kbd> > <kbd>Install Plugin</kbd>
- Manually:
  - From official jetbrains store Download the `latest release` and install it manually using <kbd>Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Install plugin from disk...</kbd>

## Usage
### Use IDE menu

### Use hotkey
Default **Option + Ctrl + Shift + o**(Mac), **Alt + Ctrl + Shift + o** (win)

## Version Info
v2.3
>
* Resolve conflict: timeout
* new features: persistent version

v2.2
> 
* add pluginIcon.svg

v2.1
> 
* add example generate button

v2.0
> 
* Support IDEA earlier version since 192+

v1.5
> 
* Resolve conflict: JavaDocWriter component name collision

v1.4
> 
* Support IDEA earlier version since 162+

v1.3
> 
* bugFix: field support special psiType, eg. BigInteger...
* bugFix: remove Deprecated field 

v1.2
> 
* Optimizing UI Interface 
* bugFix: field description should support special char `space`

v1.1
> 
* Support UI operation
* Only Support for interface class

v1.0
> first version
* Support for public method
* Supports shortcut to open ServiceDoc, default option + ctrl + shift + o (mac), alt + ctrl + shift + o(win)
* Support to generate servicedoc
* Support to modify the doc with memory feature