Skip to content

BoGnY/phpstorm-inheritdoc

Repository files navigation

PHP @inheritDoc plugin for PhpStorm

Build Version Downloads

PHP @inheritDoc plugin for PhpStorm / IntelliJ Idea Ultimate.

Based on PHP @inheritDoc plugin for PhpStorm by thanosp.

Original work by thanosp:

  • Folds {@inheritDoc} tags and shows the inherited text instead
  • Can suggest adding {@inheritDoc} if a docblock is missing, but a parent doc is found
  • Can suggest replacing the docblock with {@inheritDoc} if a docblock found not using {@inheritDoc}
  • Provides {@inheritDoc} code inspection

Improvements:

  • Converted plugin build system to Gradle Kotlin build script
  • Updated compatibility with PhpStorm / IntelliJ Idea Ultimate version 2020.1.X / 2020.2.X / 2020.3.X / 2021.1.X
  • Fixed wrong visualization of new line (now PhpDoc inherited new line are displayed correctly in one line)
  • Added plugin icon

Installation

  • Using IDE built-in plugin system:

    Preferences > Plugins > Marketplace > Search for "phpstorm-inheritdoc" > Install Plugin

  • Manually:

    Download the latest release and install it manually using Preferences > Plugins > ⚙️ > Install plugin from disk...


Plugin based on the IntelliJ Platform Plugin Template.