Skip to content

Commit 42a225b

Browse files
Fix javadoc unescaped chevrons.
Clarify javadoc example.
1 parent d8a24e9 commit 42a225b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

plugin-api/src/main/java/org/sonar/api/batch/sensor/SensorContext.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ public interface SensorContext {
274274
* <br/>
275275
* This method can not be used by plugins not developed by SonarSource SA.
276276
*
277-
* @param key The key must follow this convention: <pluginKey>.<entryKey>. Example: cfamily.qualityIndex
277+
* @param key The key must follow this convention: &lt;pluginKey&gt;.&lt;entryKey&gt;. Example: cfamily.qualityIndex
278278
*
279279
* @throws IllegalArgumentException if key or value parameter is null
280280
* @throws IllegalStateException if the method is called by a plugin not developed by SonarSource SA
@@ -285,8 +285,8 @@ public interface SensorContext {
285285
/**
286286
* Internal service to send data for reporting.
287287
*
288-
* @param key The key must follow this convention: <plugin_key>.<entry_key>.
289-
* where the plugin_key is your plugin key. Example: jvm.file_graph
288+
* @param key The key must follow this convention: &lt;plugin_key&gt;.&lt;entry_key&gt;.
289+
* where the plugin_key is your plugin key. Example: architecture.file_graph.jvm
290290
* @param mimeType A valid MIME type, usage of custom type and additional parameters is encouraged.
291291
* @param data The binary data to be added. The InputStream will be consumed once then closed during the method execution.
292292
*

0 commit comments

Comments
 (0)