core/com.nokia.carbide.cpp.codescanner/html/view_output.htm
author Dan Podwall <dan.podwall@nokia.com>
Mon, 27 Apr 2009 15:07:35 -0500
changeset 128 c028612cc555
parent 0 fb279309251b
permissions -rw-r--r--
merge from RCL_2_0 to MCL

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head>
<title>Viewing Reports</title>
<link rel="StyleSheet" href="../book.css" type="text/css"/>
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
</head>
   <body>
   <div class="Head1">
<h2>Viewing Reports </h2>
</div>
   <p>CodeScanner produces HTML and/or XML output, which is located in the 
   specified <strong>Reports directory</strong> as configured in the <a href="pref_codescanner_01.htm">CodeScanner &gt; General</a> preference panel. </p>
   <p>CodeScanner produces: </p>
   <ul>
     <li>A list of the tests that CodeScanner  performs and the number of times each test has 
       detected an issue in the source code scanned. Issues are grouped into categories for easier identification and reading. </li>
     <li>A statistical summary of the results of the tests run and issues found. This is a CSV file.</li>
     <li>A component analysis - a list of components and the number of issues found in each. To 
       view the component analysis, from the <span class="code">index.html</span> page, select the hyperlink Component 
       Analysis. To select detailed information on the issues in a component, select the hyperlink 
       of the component name </li>
     <li>A means to hyperlink to source code cross-referencing tools, such as LXR </li>
   </ul>
   <p class="note"><b>NOTE</b> LXR is an open source code index and cross-referencing tool that provides web-based 
     browsing of source code with links to the definition and usage of identifiers. It can be found 
   at <a href="http://sourceforge.net/projects/lxr">sourceforge.net/projects/lxr</a>.</p>
     <div class="step">
       <h4>Viewing the results of a scan</h4>
       <ol>
         <li>Navigate to the Reports directory and locate the most recent folder named by date </li>
         <li>To view a specific report type:
           <ul>
             <li>To view  the html report,  open the problemIndex.html file</li>
             <li>To view the xml report,  open the problemIndex.xml file</li>
           </ul>
         </li>
       
         <li>To view specific result information: 
           <ul>
             
             <li>Click a test name shown in red to view details of an issue</li>
		   <li>Click Component Analysis to view a list of the components in the code that was 
		     scanned</li>
		   </ul>
         </li>
       </ol>
   </div>
     <div id="footer">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
   </body>
   </html>