Skip to content

Commit 11383bf

Browse files
Bananeweizenlkoe
authored andcommitted
remove empty lines in example code
If a line break is inside a pre block, it will be rendered as is, therefore leading to empty lines at the begin or end of some of the example code blocks in the documentation.
1 parent 08fda66 commit 11383bf

File tree

4 files changed

+8
-15
lines changed

4 files changed

+8
-15
lines changed

net.sf.eclipsecs.doc/src/main/resources/partials/builtin-config.html

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ <h1>Provide a custom built-in configuration</h1>
1414
<p>
1515
<b>Example:</b>
1616
</p>
17-
<pre><code>
18-
&lt;extension
17+
<pre><code>&lt;extension
1918
id="checkstyle.CheckConfiguration"
2019
point="net.sf.eclipsecs.core.configurations"&gt;
2120
&lt;check-configuration
@@ -24,13 +23,11 @@ <h1>Provide a custom built-in configuration</h1>
2423
description="Sample Built-in configuration"&gt;
2524
&lt;property name="maxLineLength" value="50"/&gt;
2625
&lt;/check-configuration&gt;
27-
&lt;/extension&gt;
28-
</code></pre>
26+
&lt;/extension&gt;</code></pre>
2927
<p>
3028
<b>Example 2 - custom built-in config to become the default configuration (highest default-weight wins):</b>
3129
</p>
32-
<pre><code>
33-
&lt;extension
30+
<pre><code>&lt;extension
3431
id="checkstyle.CheckConfiguration"
3532
point="net.sf.eclipsecs.core.configurations"&gt;
3633
&lt;check-configuration
@@ -40,6 +37,5 @@ <h1>Provide a custom built-in configuration</h1>
4037
default-weight="10"&gt;
4138
&lt;property name="maxLineLength" value="50"/&gt;
4239
&lt;/check-configuration&gt;
43-
&lt;/extension&gt;
44-
</code></pre>
40+
&lt;/extension&gt;</code></pre>
4541
</div>

net.sf.eclipsecs.doc/src/main/resources/partials/custom-checks.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ <h1>Providing custom Checkstyle checks</h1>
5252
good idea to include this document type declaration to your metadata file: </p>
5353
<pre><code>&lt;!DOCTYPE checkstyle-metadata
5454
PUBLIC &quot;-//eclipse-cs//DTD Check Metadata 1.1//EN&quot;
55-
&quot;http://eclipse-cs.sourceforge.net/dtds/checkstyle-metadata_1_1.dtd&quot;&gt;
56-
</code></pre>
55+
&quot;http://eclipse-cs.sourceforge.net/dtds/checkstyle-metadata_1_1.dtd&quot;&gt;</code></pre>
5756
<p>This way you can validate your metadata file against the dtd using your preferred XML editor.</p>
5857
<p> The dtd file itself contains an abundance of documentation on the tags and their attributes, further
5958
further practical reference you may want to peek into the <code>net.sf.eclipsecs.checkstyle</code>

net.sf.eclipsecs.doc/src/main/resources/partials/custom-filters.html

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,15 @@ <h1>Custom plugin filters</h1>
1515
</p>
1616
<p>Example:</p>
1717
<p>Using the <code>net.sf.eclipsecs.core.filters</code> extension point in your <code>plugin.xml</code></p>
18-
<pre><code>
19-
&lt;extension
18+
<pre><code>&lt;extension
2019
id="checkstyle.CheckstyleFilters"
2120
point="net.sf.eclipsecs.core.filters"&gt;
2221
&lt;filter
2322
name="Sample Filter"
2423
internal-name="SampleFilter"
2524
description="Sample Filter"
2625
class="net.sf.eclipsecs.sample.filter.SampleFilter"/&gt;
27-
&lt;/extension&gt;
28-
</code></pre>
26+
&lt;/extension&gt;</code></pre>
2927
<p>The filter implementation class must implement the
3028
<code>net.sf.eclipsecs.core.projectconfig.filters.IFilter</code> interface.<br/> To make life a bit easier
3129
for you there is the <code>net.sf.eclipsecs.core.projectconfig.filters.AbstractFilter</code> class which

net.sf.eclipsecs.doc/src/main/resources/partials/extensions.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ <h1>Extending the Eclipse Checkstyle Plugin</h1>
1818
not as complicated as it sounds.</p>
1919
<p> The easiest way is to check out the sample eclipse-cs extension plugin from the Git repository, this sample
2020
plugin provides an example for each documented extension hook.</p>
21-
<p>The repository location is: <code>git://git.code.sf.net/p/eclipse-cs/git</code><br/>The project to check out is:
21+
<p>The repository location is: <code>https://github.com/checkstyle/eclipse-cs.git</code><br/>The project to check out is:
2222
<code>net.sf.eclipsecs.sample</code></p>
2323
<p>After you got the project in your workspace you can just disconnect it from the Git and rename the project and
2424
the plugins symbolic bundle name in <code>META-INF/MANIFEST.MF</code> to your liking.</p>

0 commit comments

Comments
 (0)