JavaDoc Sync Plugin 10

Compatible with  IntelliJ IDEA
02.04.2016
5 350
The JavaDoc Sync Plugin will assist you to keep your JavaDoc in sync between interface definitions and the implementations, or method definitions and method overrides. The plugin now uses template based generation of JavaDoc, so that the JavaDoc text can now easily be customized to your needs.

The JavaDoc Sync Plugin was originally written by Raymond Brandon but was updated for IntelliJ 8 by woofgl

The JavaDoc Sync Plugin can:
  • highlight methods that define the @inheritDoc tag but there's no super method
  • highlight methods that define the @inheritDoc tag but the super method doesn't have javaDoc
  • highlight a class if one or more methods do not define JavaDoc
  • Generate JavaDoc for all methods that do not define JavaDoc according to user defined templates
  • Ignore methods that do not match the configured access modifier level
  • Ignore overridden methods of anonymous classes or inner classes
  • highlight methods that do not have JavaDoc
  • highlight fields that do not have JavaDoc
  • highlight methods of interface implementations of which the JavaDoc differs from the JavaDoc defined at interface level
  • highlight overridden methods/constructors of which the JavaDoc differs from the JavaDoc defined in the super classes

When the JavaDoc Sync Plugin detects differences between the defining interface or base method and the implementing or overriding method, the user will get quick fixes presented to update the JavaDoc like:
  • Copy JavaDoc from parent
  • Move to parent and introduce reference
  • Replace parent JavaDoc
  • Generate JavaDoc from signature
  • Generate JavaDoc from field
  • Generate JavaDoc for all methods

To turn on the JavaDoc Sync plugin, go to Settings->Errors and select "JavaDoc issues"

Download plugin

Version

Update date

Recent change notes

JavaDoc Sync Plugin update idea 16

General usage instructions

recompile javadoc sync 8 to 10
17.10.2012
Great plugin, when can we expect recompilation for Idea 11?
07.02.2012
ditto. getting same error as reported above. IDEA Community Edition 11.1 - Thanks!
21.12.2011
Love this plugin, but it does not work with Idea 11. I get:


com.intellij.psi.PsiElementFactory.createDocCommentFromText(Ljava/lang/String;Lcom/intellij/psi/PsiElement;)Lcom/intellij/psi/javadoc/PsiDocComment;: com.intellij.psi.PsiElementFactory.createDocCommentFromText(Ljava/lang/String;Lcom/intellij/psi/PsiElement;)Lcom/intellij/psi/javadoc/PsiDocComment;
java.lang.NoSuchMethodError: com.intellij.psi.PsiElementFactory.createDocCommentFromText(Ljava/lang/String;Lcom/intellij/psi/PsiElement;)Lcom/intellij/psi/javadoc/PsiDocComment;
at com.perniciouspenguins.ideaz.javadoc.fixes.GenerateFromSignature.doFix(GenerateFromSignature.java:31)
at com.perniciouspenguins.ideaz.javadoc.fixes.LocalQuickFixBase$1.run(LocalQuickFixBase.java:86)
at com.intellij.openapi.application.impl.ApplicationImpl.runWriteAction(ApplicationImpl.java:874)
at com.perniciouspenguins.ideaz.javadoc.fixes.LocalQuickFixBase.applyFix(LocalQuickFixBase.java:82)
at com.perniciouspenguins.ideaz.javadoc.fixes.LocalQuickFixBase.applyFix(LocalQuickFixBase.java:13)
at com.intellij.codeInspection.ex.QuickFixWrapper.invoke(QuickFixWrapper.java:81)
at com.intellij.codeInsight.intention.impl.ShowIntentionActionsHandler$2.run(ShowIntentionActionsHandler.java:158)
at com.intellij.openapi.application.impl.ApplicationImpl.runWriteAction(ApplicationImpl.java:874)
at com.intellij.codeInsight.intention.impl.ShowIntentionActionsHandler$3.run(ShowIntentionActionsHandler.java:171)
at com.intellij.openapi.command.impl.CommandProcessorImpl.executeCommand(CommandProcessorImpl.java:112)
at com.intellij.openapi.command.impl.CommandProcessorImpl.executeCommand(CommandProcessorImpl.java:88)
at com.intellij.openapi.command.impl.CommandProcessorImpl.executeCommand(CommandProcessorImpl.java:76)
at com.intellij.codeInsight.intention.impl.ShowIntentionActionsHandler.chooseActionAndInvoke(ShowIntentionActionsHandler.java:176)
at com.intellij.codeInsight.intention.impl.IntentionListStep$2$1.run(IntentionListStep.java:232)
at com.intellij.openapi.application.impl.LaterInvocator$FlushQueue.run(LaterInvocator.java:333)
at java.awt.event.InvocationEvent.dispatch(InvocationEvent.java:209)
at java.awt.EventQueue.dispatchEventImpl(EventQueue.java:641)
at java.awt.EventQueue.access$000(EventQueue.java:84)
at java.awt.EventQueue$1.run(EventQueue.java:602)
at java.awt.EventQueue$1.run(EventQueue.java:600)
at java.security.AccessController.doPrivileged(Native Method)
at java.security.AccessControlContext$1.doIntersectionPrivilege(AccessControlContext.java:87)
at java.awt.EventQueue.dispatchEvent(EventQueue.java:611)
at com.intellij.ide.IdeEventQueue.e(IdeEventQueue.java:686)
at com.intellij.ide.IdeEventQueue._dispatchEvent(IdeEventQueue.java:534)
at com.intellij.ide.IdeEventQueue.b(IdeEventQueue.java:416)
at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:374)
at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:269)
at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:184)
at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:174)
at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:169)
at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:161)
at java.awt.EventDispatchThread.run(EventDispatchThread.java:122)
Please  sign in  to leave a comment.