doc/manual/gui.html - Issue 139673002: Updating Findbugs from 2.0.1 to 2.0.3

Unified Diff: doc/manual/gui.html

Issue 139673002: Updating Findbugs from 2.0.1 to 2.0.3 (Closed) Base URL: https://chromium.googlesource.com/chromium/deps/findbugs.git@master

Patch Set: bulach's nits Created 6 years, 11 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: doc/manual/gui.html

diff --git a/doc/manual/gui.html b/doc/manual/gui.html

index 44f874f577364f0e818a5e0f0dfcece4d931df10..122b074d35ac727cc911a392196e0f4c9b8eb41e 100644

--- a/doc/manual/gui.html

+++ b/doc/manual/gui.html

@@ -1,8 +1,8 @@

- <title>Chapter 5. Using the FindBugs GUI</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="running.html" title="Chapter 4. Running FindBugs™"><link rel="next" href="anttask.html" title="Chapter 6. Using the FindBugs™ Ant task"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 5. Using the <span class="application">FindBugs</span> GUI</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="running.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="anttask.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 5. Using the FindBugs GUI"><div class="titlepage"><div><div><h2 class="title"><a name="gui"></a>Chapter 5. Using the <span class="application">FindBugs</span> GUI</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="gui.html#d0e1079">1. Creating a Project</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e1121">2. Running the Analysis</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e1126">3. Browsing Results</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e1141">4. Saving and Opening</a></span></dt></dl></div><p>

+ <title>Chapter 5. Using the FindBugs GUI</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="running.html" title="Chapter 4. Running FindBugs™"><link rel="next" href="anttask.html" title="Chapter 6. Using the FindBugs™ Ant task"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 5. Using the <span class="application">FindBugs</span> GUI</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="running.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="anttask.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 5. Using the FindBugs GUI"><div class="titlepage"><div><div><h2 class="title"><a name="gui"></a>Chapter 5. Using the <span class="application">FindBugs</span> GUI</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="gui.html#d0e1092">1. Creating a Project</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e1134">2. Running the Analysis</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e1139">3. Browsing Results</a></span></dt><dt><span class="sect1"><a href="gui.html#d0e1154">4. Saving and Opening</a></span></dt></dl></div><p>

This chapter describes how to use the <span class="application">FindBugs</span> graphical user interface (GUI).

- </p><div class="sect1" title="1. Creating a Project"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1079"></a>1. Creating a Project</h2></div></div></div><p>

+ </p><div class="sect1" title="1. Creating a Project"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1092"></a>1. Creating a Project</h2></div></div></div><p>

After you have started <span class="application">FindBugs</span> using the <span class="command"><strong>findbugs</strong></span> command,

choose the <span class="guimenu">File</span> → <span class="guimenuitem">New Project</span>

menu item. You will see a dialog which looks like this:

@@ -28,14 +28,14 @@ archives/directories and are not in the standard runtime classpath. Some of the

pattern detectors in <span class="application">FindBugs</span> make use of class hierarchy information,

so you will get more accurate results if the entire class hierarchy is

available which <span class="application">FindBugs</span> performs its analysis.

-</p></div><div class="sect1" title="2. Running the Analysis"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1121"></a>2. Running the Analysis</h2></div></div></div><p>

+</p></div><div class="sect1" title="2. Running the Analysis"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1134"></a>2. Running the Analysis</h2></div></div></div><p>

Once you have added all of the archives, directories, and source directories,

click the "Analyze" button to analyze the classes contained in the

Jar files. Note that for a very large program on an older computer,

this may take quite a while (tens of minutes). A recent computer with

ample memory will typically be able to analyze a large program in only a

few minutes.

-</p></div><div class="sect1" title="3. Browsing Results"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1126"></a>3. Browsing Results</h2></div></div></div><p>

+</p></div><div class="sect1" title="3. Browsing Results"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1139"></a>3. Browsing Results</h2></div></div></div><p>

When the analysis completes, you will see a screen like the following:

</p><div class="mediaobject"><img src="example-details.png"></div><p>

</p><p>

@@ -54,7 +54,7 @@ You may add a textual annotations to bug instances. To do so, type them

into the text box just below the hierarchical view. You can type any

information which you would like to record. When you load and save bug

results files, the annotations are preserved.

-</p></div><div class="sect1" title="4. Saving and Opening"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1141"></a>4. Saving and Opening</h2></div></div></div><p>

+</p></div><div class="sect1" title="4. Saving and Opening"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1154"></a>4. Saving and Opening</h2></div></div></div><p>

You may use the <span class="guimenu">File</span> → <span class="guimenuitem">Save as...</span>

menu option to save your work. To save your work, including the jar

file lists you specified and all bug results, choose

« no previous file with comments | « doc/manual/filter.html ('k') | doc/manual/index.html » ('j') | no next file with comments »