Skip to content

Commit 78350f2

Browse files
authored
Merge pull request #2797 from ger-benjamin/improve-processor-doc
Improve/fix processors doc
2 parents dcffab9 + f239d5a commit 78350f2

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

core/src/main/java/org/mapfish/print/processor/AbstractProcessor.java

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ public final BiMap<String, String> getInputMapperBiMap() {
5757
}
5858

5959
/**
60-
* The prefix to apply to each value. This provides a simple way to make all output values have unique
61-
* values.
60+
* The prefix to apply to each value. This provides a simple way to make all input and output values
61+
* have unique values.
6262
*
6363
* @param prefix the new prefix
6464
*/
@@ -72,7 +72,7 @@ public final String getInputPrefix() {
7272
}
7373

7474
/**
75-
* The prefix to apply to each input value. This provides a simple way to make all output values have
75+
* The prefix to apply to each input value. This provides a simple way to make all input values have
7676
* unique values.
7777
*
7878
* @param inputPrefix the new prefix
@@ -110,7 +110,10 @@ public void toString(final StringBuilder builder, final int indent, final String
110110
}
111111

112112
/**
113-
* The input mapper.
113+
* <p>The input mapper. See "Processors" to know more. Example:</p>
114+
* <pre><code>
115+
* inputMapper: {attributeName: defaultInputParamName}
116+
* </code></pre>
114117
*
115118
* @param inputMapper the values.
116119
*/
@@ -125,7 +128,10 @@ public final BiMap<String, String> getOutputMapperBiMap() {
125128
}
126129

127130
/**
128-
* The output mapper.
131+
* <p>The output mapper. See "Processors" to know more. Example:</p>
132+
* <pre><code>
133+
* outputMapper: {defaultOutputName: templateParamName}
134+
* </code></pre>
129135
*
130136
* @param outputMapper the values.
131137
*/

0 commit comments

Comments
 (0)