You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@netbeans.apache.org by gi...@apache.org on 2019/03/01 10:04:15 UTC
[incubator-netbeans-website] branch asf-site updated: Automated
site publishing by Jenkins build 624
This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-netbeans-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 6e74a8f Automated site publishing by Jenkins build 624
6e74a8f is described below
commit 6e74a8ff501bb536f6825dc644c7e281b1e85e71
Author: jenkins <bu...@apache.org>
AuthorDate: Fri Mar 1 10:04:13 2019 +0000
Automated site publishing by Jenkins build 624
---
content/kb/docs/java/code-inspect.html | 95 ++++++++++++++++++++--------------
1 file changed, 56 insertions(+), 39 deletions(-)
diff --git a/content/kb/docs/java/code-inspect.html b/content/kb/docs/java/code-inspect.html
index db187c5..eaeea4e 100644
--- a/content/kb/docs/java/code-inspect.html
+++ b/content/kb/docs/java/code-inspect.html
@@ -101,10 +101,10 @@
<li><a href="#_setting_up_the_tutorial_environment">Setting Up the Tutorial Environment</a></li>
<li><a href="#_using_predefined_configurations">Using Predefined Configurations</a>
<ul class="sectlevel2">
-<li><a href="#_running_all_analyzers">Running All Analyzers</a></li>
-<li><a href="#_verifying_java_code_against_netbeans_java_hints">Verifying Java Code against NetBeans Java Hints</a></li>
-<li><a href="#_finding_potential_problems_in_java_code_with_findbugs">Finding Potential Problems in Java Code with FindBugs</a></li>
-<li><a href="#_customizing_a_default_configuration">Customizing a Default Configuration</a></li>
+<li><a href="#all">Running All Analyzers</a></li>
+<li><a href="#hints">Verifying Java Code against NetBeans Java Hints</a></li>
+<li><a href="#fb">Finding Potential Problems in Java Code with FindBugs</a></li>
+<li><a href="#default">Customizing a Default Configuration</a></li>
</ul>
</li>
<li><a href="#_creating_and_deleting_configurations">Creating and Deleting Configurations</a></li>
@@ -165,8 +165,8 @@
<div class="paragraph">
<p>If using another NetBeans project, <a href="http://repo1.maven.org/maven2/com/google/code/findbugs/jsr305/2.0.0/jsr305-2.0.0.jar">jsr305-2.0.0.jar</a> should be downloaded and added to the Libraries folder of the your project in the IDE as follows:</p>
</div>
-<div class="olist arabic">
-<ol class="arabic">
+<div class="olist lowerroman">
+<ol class="lowerroman" type="i" start="1">
<li>
<p>Right-click the Libraries folder and choose the Add JAR/Folder from the popup menu.</p>
</li>
@@ -193,10 +193,13 @@
<li>
<p>The <a href="https://netbeans.org/projects/samples/downloads/download/Samples/Java/library.zip">library.zip</a> file should be unzipped into your NetBeans project folder and opened in the NetBeans IDE.</p>
</li>
-<li>
+</ul>
+</div>
+<div class="paragraph">
<p>The FindBugs plugin should be downloaded and installed into the NetBeans IDE as follows:</p>
+</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="1">
<li>
<p>Choose Source > Inspect from the main IDE’s menu.</p>
</li>
@@ -205,9 +208,6 @@
</li>
</ol>
</div>
-</li>
-</ul>
-</div>
<div class="openblock feature">
<div class="content">
<div class="imageblock left">
@@ -218,7 +218,7 @@
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="3">
<li>
<p>In the Installer dialog box, click Next to proceed with the installation.</p>
</li>
@@ -234,7 +234,7 @@
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="4">
<li>
<p>Review the license agreement, select the license agreement option, and click Install.</p>
</li>
@@ -268,7 +268,7 @@
</ul>
</div>
<div class="sect2">
-<h3 id="_running_all_analyzers">Running All Analyzers</h3>
+<h3 id="all">Running All Analyzers</h3>
<div class="paragraph">
<p>The <code>All Analyzers</code> configuration deploys all static code analysis tools available in the IDE.</p>
</div>
@@ -310,7 +310,7 @@ You need to install the <a href="#plugin">FindBugs</a> plugin to run this config
</table>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="4">
<li>
<p>Click Inspect.
The results of the analysis are displayed in the Inspector Window as a tree view on the left.</p>
@@ -345,7 +345,8 @@ The results of the analysis are displayed in the Inspector Window as a tree view
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
-If you want to leave some part of your code that is reported as problematic as is, the IDE allows you to suppress the warning for this code to leave it without any changes. You can double-click a warning in the tree view of the Inspector Window to go to the Source Editor. Press Alt-Enter, click the black arrow pointing to the right at the end of the displayed hint, and choose <code>SuppressWarning - <em>(warning name)</em></code> .
+If you want to leave some part of your code that is reported as problematic as is, the IDE allows you to suppress the warning for this code to leave it without any changes. You can double-click a warning in the tree view of the Inspector Window to go to the Source Editor.<br>
+Press <span class="keyseq"><kbd>Alt</kbd>+<kbd>Enter</kbd></span>, click the black arrow pointing to the right at the end of the displayed hint, and choose <code>SuppressWarning - <em>(warning name)</em></code> .
</td>
</tr>
</table>
@@ -361,7 +362,7 @@ If you want to leave some part of your code that is reported as problematic as i
</div>
</div>
<div class="sect2">
-<h3 id="_verifying_java_code_against_netbeans_java_hints">Verifying Java Code against NetBeans Java Hints</h3>
+<h3 id="hints">Verifying Java Code against NetBeans Java Hints</h3>
<div class="paragraph">
<p>The <code>NetBeans Java Hints</code> configuration available in the IDE enables you to verify if the predefined coding standard rules are satisfied by the source code under consideration. In other words, it applies a set of NetBeans Java Hints (also known as code inspections) to your Java source files.</p>
</div>
@@ -391,7 +392,7 @@ You can define a scope (a file, package, or project(s)) for the <code>NetBeans
</table>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="3">
<li>
<p>Select the Configuration radio button and choose <code>NetBeans Java Hints</code> in the drop-down list.</p>
</li>
@@ -407,7 +408,7 @@ You can define a scope (a file, package, or project(s)) for the <code>NetBeans
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="4">
<li>
<p>Click Inspect.
The IDE displays the tree view with the results of the analysis with the <code>NetBeans Java Hints</code> configuration in the Inspector Window.</p>
@@ -420,7 +421,7 @@ The IDE displays the tree view with the results of the analysis with the <code>
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="5">
<li>
<p>In the Inspector Window, click the <a href="#categorize">Categorize</a> button in the toolbar on the left to view the problems grouped into categories.</p>
</li>
@@ -447,22 +448,38 @@ The IDE displays the tree view with the results of the analysis with the <code>
<td class="tableblock halign-left valign-top"><p class="tableblock">Function</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">image::images/refreshbutton.png[]</p></td>
+<td class="tableblock halign-left valign-top"><div><div class="imageblock">
+<div class="content">
+<img src="images/refreshbutton.png" alt="refreshbutton">
+</div>
+</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Refresh</strong></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Displays a refreshed list of the static analysis results.</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">image::images/upbutton.png[]</p></td>
+<td class="tableblock halign-left valign-top"><div><div class="imageblock">
+<div class="content">
+<img src="images/upbutton.png" alt="upbutton">
+</div>
+</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Previous Problem</strong></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Displays the previous problem in the list of the static analysis results.</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">image::images/downbutton.png[]</p></td>
+<td class="tableblock halign-left valign-top"><div><div class="imageblock">
+<div class="content">
+<img src="images/downbutton.png" alt="downbutton">
+</div>
+</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Next Problem</strong></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Displays the following problem in the list of the static analysis results.</p></td>
</tr>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">image::images/categorizebutton.png[]</p></td>
+<td class="tableblock halign-left valign-top"><div><div class="imageblock">
+<div class="content">
+<img src="images/categorizebutton.png" alt="categorizebutton">
+</div>
+</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Categorize</strong></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Toggles the collapsed view of the problems detected in a file, project, or package or the categorized view of all the detected problems.</p></td>
</tr>
@@ -470,7 +487,7 @@ The IDE displays the tree view with the results of the analysis with the <code>
</table>
</div>
<div class="sect2">
-<h3 id="_finding_potential_problems_in_java_code_with_findbugs">Finding Potential Problems in Java Code with FindBugs</h3>
+<h3 id="fb">Finding Potential Problems in Java Code with FindBugs</h3>
<div class="paragraph">
<p>The <code>FindBugs</code> configuration available in the IDE enables you to find a wide range of potential problems in your code. It invokes the popular open source FindBugs tool for code analysis in Java. The bug report gets generated and is displayed in the Inspector Window of the NetBeans IDE, which categorizes all the found problems and allows direct navigation from the bugs in the report to the suspicious code. You can also read a bug description in the adjacent window or revie [...]
</div>
@@ -512,7 +529,7 @@ You can inspect a file, package, or project(s) with the <code>FindBugs</code>
</table>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="3">
<li>
<p>In the Inspect dialog box, select the <code>FindBugs</code> configuration.</p>
</li>
@@ -528,7 +545,7 @@ You can inspect a file, package, or project(s) with the <code>FindBugs</code>
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="4">
<li>
<p>Click the Inspect button to initiate the static code analysis.
The result of the static code analysis is displayed in the Inspector Window below the Source Editor.
@@ -546,7 +563,7 @@ The description of the selected bug is displayed in the frame on the right.</p>
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="5">
<li>
<p>Alternatively, click the <a href="#categorize">Categorize</a> button in the toolbar on the left to view the bugs grouped into categories.</p>
</li>
@@ -564,8 +581,8 @@ The description of the selected bug is displayed in the frame on the right.</p>
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
-If you double-click an issue in the expanded list, the IDE displays the reported issue in the Source Editor.
-Press Alt-Enter to view the bug description in the source code.
+If you double-click an issue in the expanded list, the IDE displays the reported issue in the Source Editor.<br>
+Press <span class="keyseq"><kbd>Alt</kbd>+<kbd>Enter</kbd></span> to view the bug description in the source code.
</td>
</tr>
</table>
@@ -617,13 +634,13 @@ Potential errors are highlighted in the code with exclamation mark icons (image:
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="4">
<li>
<p>Select the Run FindBugs in Editor option.</p>
</li>
<li>
<p>Click OK.
-If you now press Alt-Enter in the source code where a bug is reported and click the black arrow pointing to the right at the end of the displayed tip, the IDE shows some fixing options for a potential bug.</p>
+If you now press <span class="keyseq"><kbd>Alt</kbd>+<kbd>Enter</kbd></span> in the source code where a bug is reported and click the black arrow pointing to the right at the end of the displayed tip, the IDE shows some fixing options for a potential bug.</p>
</li>
</ol>
</div>
@@ -638,7 +655,7 @@ If you now press Alt-Enter in the source code where a bug is reported and click
</div>
</div>
<div class="sect2">
-<h3 id="_customizing_a_default_configuration">Customizing a Default Configuration</h3>
+<h3 id="default">Customizing a Default Configuration</h3>
<div class="paragraph">
<p>While working on your code you may need to customize a predefined configuration that includes your own NetBeans Java hints or FindBugs bugs.</p>
</div>
@@ -665,7 +682,7 @@ The IDE displays the Configurations dialog box.</p>
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="4">
<li>
<p>Ensure <code>Default</code> is selected in the Configurations drop-down list.</p>
</li>
@@ -687,7 +704,7 @@ The IDE displays the Configurations dialog box.</p>
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="7">
<li>
<p>Click OK to save your <code>Default</code> configuration.</p>
</li>
@@ -735,7 +752,7 @@ The IDE displays the Configurations dialog box.</p>
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="5">
<li>
<p>In the Analyzer drop-down list, choose <code>JRE 8 Profiles Conformance</code> , <code>Netbeans Java Hints</code> , or <code>FindBugs</code> .</p>
</li>
@@ -764,7 +781,7 @@ The created <code>newConfig</code> configuration is available in the Configura
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
-To rename a configuration, select the <code>newConfig</code> configuration in the Configurations drop-down list, click the black arrow at the end of the Configurations drop-down list and choose Rename. Type a new name (for example, <code>renamedConfig</code> ) and press Enter to save your edits.
+To rename a configuration, select the <code>newConfig</code> configuration in the Configurations drop-down list, click the black arrow at the end of the Configurations drop-down list and choose Rename. Type a new name (for example, <code>renamedConfig</code> ) and press <kbd>Enter</kbd> to save your edits.
</td>
</tr>
</table>
@@ -799,7 +816,7 @@ To rename a configuration, select the <code>newConfig</code> configuration in
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="5">
<li>
<p>In the Delete Configuration dialog box, click Yes to confirm the deletion of the configuration.</p>
</li>
@@ -882,7 +899,7 @@ Refer to the <a href="http://platform.netbeans.org/tutorials/nbm-java-hint.html"
</div>
</div>
<div class="olist arabic">
-<ol class="arabic">
+<ol class="arabic" start="4">
<li>
<p>In the Inspect dialog box, click Inspect to perform the source code analysis.
After the Inspect operation is completed, the hints that can be applied to your code or bugs that have been found are displayed in the Inspector Window below the Source Editor.</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@netbeans.apache.org
For additional commands, e-mail: commits-help@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists