disallow {@code} in javadoc (#2191)

* disallow {@code} in Javadoc

* cleanup

* resolve

* rollback

* replace @code

* replace @code

* cleanup

Author: russelmrcl

annot/src/main/java/com/predic8/membrane/annot/model/doc/Doc.java

@@ -113,6 +113,10 @@ private void handle(String key, String value) {
 			return;
 		}
 
+        if (value.contains("{@code")) {
+            processingEnv.getMessager().printMessage(Kind.ERROR, "@code not allowed!", e);
+        }
+
 		keys.add(key);
 		entries.add(new Entry(key, value));
 	}

core/src/main/java/com/predic8/membrane/core/config/security/Store.java

@@ -85,7 +85,7 @@ public String getType() {
 	}
 
 	/**
-	 * @description Keystore type (e.g., {@code PKCS12}, {@code JKS}).
+	 * @description Keystore type (e.g., <code>PKCS12</code>, <code>JKS</code>).
 	 */
 	@MCAttribute
 	public void setType(String type) {

core/src/main/java/com/predic8/membrane/core/interceptor/Outcome.java

@@ -14,7 +14,7 @@
 package com.predic8.membrane.core.interceptor;
 
 /**
- * Also see {@link InterceptorFlowController}.
+ * Also see {@link FlowController}.
  */
 public enum Outcome {
 

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/ApiKeysInterceptor.java

@@ -151,8 +151,8 @@ public Optional<LocationNameValue> getKey(Exchange exc) {
     }
 
     /**
-     * @description Controls whether API key validation is enforced. If set to {@code false}, the interceptor still extracts
-     * keys and loads scopes so they remain available for downstream checks (e.g., via {@code hasScope("...")}), but requests
+     * @description Controls whether API key validation is enforced. If set to <code>false</code>, the interceptor still extracts
+     * keys and loads scopes so they remain available for downstream checks (e.g., via <code>hasScope("...")</code>), but requests
      * without a valid key are allowed to pass.
      * @default true
      * @example false
@@ -173,12 +173,11 @@ public boolean isRequired() {
      * <p>
      * Example:
      * </p>
-     * <pre><code>
-     * &lt;apiKey&gt;
-     *   &lt;!-- store elements; order does not matter --&gt;
-     *   &lt;yourFileStore src="classpath:keys.txt"/&gt;
-     *   &lt;yourXmlStore  ref="sharedKeysBean"/&gt;
-     * &lt;/apiKey&gt;</code></pre>
+     * <pre><code><apiKey>
+     *   <!-- store elements; order does not matter -->
+     *   <yourFileStore src="classpath:keys.txt"/>
+     *   <yourXmlStore  ref="sharedKeysBean"/>;
+     * </apiKey></code></pre>
      */
     @MCChildElement(allowForeign = true)
     public void setStores(List<ApiKeyStore> stores) {
@@ -192,7 +191,7 @@ public List<ApiKeyStore> getStores() {
     /**
      * @description Configures how and where API keys are extracted from requests (e.g., HTTP header or URL query parameter).
      * Provide one or more extractor elements. If omitted, a header extractor using <code>X-Api-Key</code> is used.
-     * @default &lt;headerExtractor /&gt; (header name <code>X-Api-Key</code>)
+     * @default <headerExtractor /> (header name <code>X-Api-Key</code>)
      * <p>
      * Examples:
      * </p>

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/extractors/ApiKeyExpressionExtractor.java

@@ -30,19 +30,17 @@
 /**
  * @description Extracts an API key by evaluating an expression on the incoming request.
  * The result (a string) is treated as the API key. The expression is evaluated in the configured language
- * (default: {@code SPEL}) during the request flow.
+ * (default: <code>SPEL</code>) during the request flow.
  * <p>
- * Typical usage inside {@code &lt;apiKey&gt;}:
+ * Typical usage inside <code>&lt;apiKey&gt;</code>:
  * </p>
- * <pre>
- * &lt;apiKey&gt;
- *   &lt;expressionExtractor
+ * <pre><code><apiKey>
+ *   <expressionExtractor
  *       language="SPEL"
- *       expression="request.headers['X-Api-Key']"/&gt;
- * &lt;/apiKey&gt;
- * </pre>
+ *       expression="request.headers['X-Api-Key']"/>
+ * </apiKey></code></pre>
  * <p>
- * If the expression evaluates to {@code null} or an empty string, no key is extracted.
+ * If the expression evaluates to <code>null</code> or an empty string, no key is extracted.
  * </p>
  * @topic 3. Security and Validation
  */
@@ -88,11 +86,8 @@ public String getExpression() {
      * <p>
      * Examples (SPEL):
      * </p>
-     * <pre>
-     * expression="request.headers['X-Api-Key']"
-     *
-     * expression="request.query['api_key']"
-     * </pre>
+     * <pre><code>expression="request.headers['X-Api-Key']"
+     *  expression="request.query['api_key']"</code></pre>
      */
     @MCAttribute
     public void setExpression(String expression) {

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/extractors/ApiKeyHeaderExtractor.java

@@ -23,18 +23,16 @@
 
 /**
  * @description Extracts an API key from a specific HTTP request header. By default, the header name
- * is {@code X-Api-Key}. If the header is present, its first value is returned as the API key.
+ * is <code>X-Api-Key</code>. If the header is present, its first value is returned as the API key.
  * <p>
- * Example usage inside {@code &lt;apiKey&gt;}:
+ * Example usage inside <code>&lt;apiKey&gt;</code>:
  * </p>
- * <pre>
- * &lt;apiKey&gt;
- *   &lt;headerExtractor /&gt; <!-- default: X-Api-Key -->
+ * <pre><code><apiKey>
+ *   <headerExtractor /> <!-- default: X-Api-Key -->
  *
- *   &lt;!-- custom header name --&gt;
- *   &lt;headerExtractor name="Authorization"/&gt;
- * &lt;/apiKey&gt;
- * </pre>
+ *   <!-- custom header name -->
+ *   <headerExtractor name="Authorization"/>
+ * </apiKey></code></pre>
  * @topic 3. Security and Validation
  */
 @MCElement(name="headerExtractor", topLevel = false)

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/extractors/ApiKeyQueryParamExtractor.java

@@ -28,19 +28,17 @@
 
 /**
  * @description Extracts an API key from a URL query parameter. By default, the parameter name
- * is {@code api-key}. If the parameter is present in the request URI, its value is returned as the API key.
+ * is <code>api-key</code>. If the parameter is present in the request URI, its value is returned as the API key.
  * Parameter name matching is case-insensitive.
  * <p>
- * Example usage inside {@code &lt;apiKey&gt;}:
+ * Example usage inside <code>&lt;apiKey&gt;</code>:
  * </p>
- * <pre>
- * &lt;apiKey&gt;
- *   &lt;queryParamExtractor /&gt; <!-- default: api-key -->
+ * <pre><code><apiKey>
+ *   <queryParamExtractor /> <!-- default: api-key -->
  *
- *   &lt;!-- custom parameter name --&gt;
- *   &lt;queryParamExtractor name="api_key"/&gt;
- * &lt;/apiKey&gt;
- * </pre>
+ *   <!-- custom parameter name -->
+ *   <queryParamExtractor name="api_key"/>
+ * </apiKey></code></pre>
  * @topic 3. Security and Validation
  */
 @MCElement(name="queryParamExtractor", topLevel = false)

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/stores/ApiKeyFileStore.java

@@ -32,7 +32,7 @@
  * @description Loads API keys and optional scopes from a text file. Each non-empty line must contain a key.
  * <ul>
  *   <li>Blank lines are ignored.</li>
- *   <li>A hash sign ({@code #}) starts a comment (line or end-of-line).</li>
+ *   <li>A hash sign (<code> #</code>) starts a comment (line or end-of-line).</li>
  *   <li>Scopes can follow the key, separated by a colon. Multiple scopes are comma-separated.</li>
  * </ul>
  * <p>

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/stores/JDBCApiKeyStore.java

@@ -34,19 +34,17 @@
  * </ul>
  * <p>
  * By default, the store will attempt to create the required tables at startup if they do not exist
- * (controlled by {@code autoCreate}).
+ * (controlled by <code>autoCreate</code>).
  * </p>
  * <p>
  * Example configuration:
  * </p>
- * <pre>
- * &lt;apiKey&gt;
- *   &lt;databaseApiKeyStore autoCreate="true"&gt;
- *     &lt;keyTable name="api_keys"/&gt;
- *     &lt;scopeTable name="api_scopes"/&gt;
- *   &lt;/databaseApiKeyStore&gt;
- * &lt;/apiKey&gt;
- * </pre>
+ * <pre><code><apiKey>
+ *   <databaseApiKeyStore autoCreate="true">
+ *     <keyTable name="api_keys"/>
+ *     <scopeTable name="api_scopes"/>
+ *   </databaseApiKeyStore>
+ * </apiKey></code></pre>
  * @topic 3. Security and Validation
  */
 @MCElement(name = "databaseApiKeyStore")
@@ -149,15 +147,15 @@ private boolean tableExists(Connection connection, String tableName) throws SQLE
     }
 
     /**
-     * @description The table containing API keys. Each row must define a unique {@code apikey}.
+     * @description The table containing API keys. Each row must define a unique <code>apikey</code>.
      */
     @MCChildElement(order = 0)
     public void setKeyTable(KeyTable keyTable) {
         this.keyTable = keyTable;
     }
 
     /**
-     * @description The table mapping API keys to scopes. Each row links one {@code apikey} to one {@code scope}.
+     * @description The table mapping API keys to scopes. Each row links one <code>apikey</code> to one <code>scope</code>.
      */
     @MCChildElement(order = 1)
     public void setScopeTable(ScopeTable scopeTable) {

core/src/main/java/com/predic8/membrane/core/interceptor/apikey/stores/MongoDBApiKeyStore.java

@@ -26,8 +26,8 @@
 
 /**
  * @description Uses a MongoDB collection as a store for API keys and their scopes.
- * Each document in the collection must use the API key as its {@code _id}
- * and may define an array field {@code scopes} listing the allowed scopes.
+ * Each document in the collection must use the API key as its <code>_id}</code>
+ * and may define an array field <code>scopes</code> listing the allowed scopes.
  * <p>
  * Example MongoDB document:
  * </p>
@@ -40,14 +40,12 @@
  * <p>
  * Configuration example:
  * </p>
- * <pre>
- * &lt;apiKey&gt;
- *   &lt;mongoDBApiKeyStore
+ * <pre><code><apiKey>
+ *   <mongoDBApiKeyStore
  *       connection="mongodb://localhost:27017"
  *       database="security"
- *       collection="apikeys"/&gt;
- * &lt;/apiKey&gt;
- * </pre>
+ *       collection="apikeys"/>
+ * </apiKey></code></pre>
  * @topic 3. Security and Validation
  */
 @MCElement(name = "mongoDBApiKeyStore")