Skip to content

Commit 2f4537b

Browse files
committed
add preference help for custom folding regions
See eclipse-jdt/eclipse.jdt.ui#1825
1 parent 86cd6c1 commit 2f4537b

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed
Loading

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,50 @@ <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>
105+
<tr>
106+
<td valign="top">
107+
<p>Text marking start of region</p>
108+
</td>
109+
<td valign="top">
110+
<p>Comments starting with the content of this option indicate the start of custom folding regions.</p>
111+
</td>
112+
<td valign="top">
113+
<p>#region</p>
114+
</td>
115+
</tr>
116+
<tr>
117+
<td valign="top">
118+
<p>Text marking end of region</p>
119+
</td>
120+
<td valign="top">
121+
<p>Comments starting with the content of this option indicate the end of custom folding regions.</p>
122+
</td>
123+
<td valign="top">
124+
<p>#endregion</p>
125+
</td>
126+
</tr>
94127
</tbody>
95128
</table>
129+
<p>
130+
Custom folding regions allow creating regions to fold using a marker text for the start and end of the region in a comment.
131+
Leaving the fields for the start or end markers empty disables this feature.
132+
</p>
133+
<p>
134+
<img src=
135+
"../../../../reference/preferences/java/editor/images/ref-preferences-folding-custom-regions.PNG"
136+
alt="Custom folding regions marked with a start and end comment" />
137+
</p>
96138
<h3 class="related">Related References</h3>
97139
<a href="../ref-preferences-editor.htm">Java Editor preference page</a>
98140
</body>

0 commit comments

Comments
 (0)