Skip to content

Instantly share code, notes, and snippets.

@Bit-Flipper
Created April 6, 2024 02:18
Show Gist options
  • Save Bit-Flipper/a346788937eeb5132572376e16175bd6 to your computer and use it in GitHub Desktop.
Save Bit-Flipper/a346788937eeb5132572376e16175bd6 to your computer and use it in GitHub Desktop.

GroqDoc Scanning Recipe Example of Bad Generated Javadoc

 public interface MemberAccessValueStack {
 
+    /**
+     * Sets a set of {@link Pattern}s that represent the properties to be excluded.
+     * Any attempt to get or set a property that matches any of the patterns will
+     * result in an {@link UnsupportedOperationException}.
+     *
+     * @param excludeProperties the set of {@link Pattern}s that represent the properties to be excluded
+     * @throws NullPointerException if the given set is <code>null</code>
+     * @throws UnsupportedOperationException if an attempt to get or set a property that matches any
+     * of the patterns is made
+     * @see Pattern
+     * @see Set
+     */
     void useExcludeProperties(Set<Pattern> excludeProperties);
 
+    /**
+     * Sets a set of {@link Pattern}s that represent the properties to be accepted.
+     * Only properties that match any of the patterns will be accessible.
+     *
+     * @param acceptedProperties the set of {@link Pattern}s that represent the properties to be accepted
+     * @throws NullPointerException if the given set is <code>null</code>
+     * @see Pattern
+     * @see Set
+     */
     void useAcceptProperties(Set<Pattern> acceptedProperties);
 
 }
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment