Skip to content

Commit 3cbfbcb

Browse files
committed
add preference help for custom folding regions
See eclipse-jdt/eclipse.jdt.ui#1825
1 parent 5ff6774 commit 3cbfbcb

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

eclipse.platform.common/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/editor/ref-preferences-folding.htm

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,17 @@ <h1>Java Editor Folding Preferences</h1>
9191
<p>On</p>
9292
</td>
9393
</tr>
94+
<tr>
95+
<td valign="top">
96+
<p>Custom Folding regions</p>
97+
</td>
98+
<td valign="top">
99+
<p>If enabled, custom folding regions are folded when opening a new editor.</p>
100+
</td>
101+
<td valign="top">
102+
<p>Off</p>
103+
</td>
104+
</tr>
94105
<tr>
95106
<td valign="top">
96107
<p>Extended folding (experimental) \ Activate feature</p>
@@ -102,8 +113,45 @@ <h1>Java Editor Folding Preferences</h1>
102113
<p>Off</p>
103114
</td>
104115
</tr>
116+
<tr>
117+
<td valign="top">
118+
<p>Custom folding regions \ Enable folding of custom regions</p>
119+
</td>
120+
<td valign="top">
121+
<p>If enabled, custom regions can be folded in the editor.</p>
122+
</td>
123+
<td valign="top">
124+
<p>Off</p>
125+
</td>
126+
</tr>
127+
<tr>
128+
<td valign="top">
129+
<p>Custom folding regions \ Text marking start of region</p>
130+
</td>
131+
<td valign="top">
132+
<p>Comments starting with the content of this option indicate the start of custom folding regions.</p>
133+
</td>
134+
<td valign="top">
135+
<p>region</p>
136+
</td>
137+
</tr>
138+
<tr>
139+
<td valign="top">
140+
<p>Custom folding regions \ Text marking end of region</p>
141+
</td>
142+
<td valign="top">
143+
<p>Comments starting with the content of this option indicate the end of custom folding regions.</p>
144+
</td>
145+
<td valign="top">
146+
<p>endregion</p>
147+
</td>
148+
</tr>
105149
</tbody>
106150
</table>
151+
<p>
152+
Custom folding regions allow creating regions to fold using a marker text for the start and end of the region in a comment.
153+
Leaving the fields for the start or end markers empty disables this feature.
154+
</p>
107155
<h3 class="related">Related References</h3>
108156
<a href="../ref-preferences-editor.htm">Java Editor preference page</a>
109157
</body>

0 commit comments

Comments
 (0)