revised variables view page and added new images
authorfturovic <frank.turovich@nokia.com>
Fri, 09 Jul 2010 09:43:10 -0500
changeset 1599 e6d4a94a48d3
parent 1594 92ca7b538bd2
child 1600 58e49b4c270c
revised variables view page and added new images
core/com.nokia.carbide.cpp.doc.user/html/debugger/images/menu_view_variables_01.png
core/com.nokia.carbide.cpp.doc.user/html/debugger/images/menu_view_variables_02.png
core/com.nokia.carbide.cpp.doc.user/html/debugger/images/view_variables.png
core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_add_watchpoint.png
core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_cast_to_type.png
core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_display_as_array.png
core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_find_variables.png
core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_global_variables.png
core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_set_value.png
core/com.nokia.carbide.cpp.doc.user/html/debugger/variables/adding_variables.htm
core/com.nokia.carbide.cpp.doc.user/html/debugger/variables/viewing_variables.htm
core/com.nokia.carbide.cpp.doc.user/html/debugger/watchpoints/setting_watchpoints.htm
Binary file core/com.nokia.carbide.cpp.doc.user/html/debugger/images/menu_view_variables_01.png has changed
Binary file core/com.nokia.carbide.cpp.doc.user/html/debugger/images/menu_view_variables_02.png has changed
Binary file core/com.nokia.carbide.cpp.doc.user/html/debugger/images/view_variables.png has changed
Binary file core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_add_watchpoint.png has changed
Binary file core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_cast_to_type.png has changed
Binary file core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_display_as_array.png has changed
Binary file core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_find_variables.png has changed
Binary file core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_global_variables.png has changed
Binary file core/com.nokia.carbide.cpp.doc.user/html/debugger/images/wnd_set_value.png has changed
--- a/core/com.nokia.carbide.cpp.doc.user/html/debugger/variables/adding_variables.htm	Wed Jul 07 15:29:48 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/debugger/variables/adding_variables.htm	Fri Jul 09 09:43:10 2010 -0500
@@ -1,24 +1,23 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
-<meta http-equiv="Content-Style-Type" content="text/css" />
-<meta name="LASTUPDATED" content="06/17/05 11:09:43" />
-<title>Adding and Removing Global Variables</title>
-<link rel="StyleSheet" href="../../../book.css" type="text/css"/>
-</head>
-<body bgcolor="#FFFFFF">
-<h2>Adding and Removing Global Variables </h2>
-<p>The <a href="viewing_variables.htm">Variables</a> view can also display global variables used by the program. Right-click in the <a href="viewing_variables.htm">Variables</a> view and select the <b>Add Global Variables</b> menu option to open the <b>Global Variables</b> dialog. There you can select one or more global variables to display in the Variables view, clickiing <b>OK</b> when done. </p>
-<p align="center"><img src="../../images/views/wnd_select_global_variables.png" width="345" height="430" /></p>
-<p class="figure">Figure 1 - Global Variables selection dialog</p>
-<p>&nbsp;</p>
-<h4>Removing Global Variables</h4>
-<p>Right-click in the <a href="viewing_variables.htm">Variables</a> view and select the <b>Add Global Variables</b> menu option to open the <b>Global Variables</b> dialog. Locate and uncheckmark the global variable to stop displaying, then click <b>OK</b>. This removes the selected global variable from the variables list.</p>
-<h5>Other references</h5>
-<ul>
-  <li><a href="variables.htm">Variables and Expressions Overview</a></li>
-</ul>
-<div id="footer">Copyright &copy; 2010 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>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+<meta http-equiv="Content-Style-Type" content="text/css" />
+<meta name="LASTUPDATED" content="06/17/05 11:09:43" />
+<title>Adding and Removing Global Variables</title>
+<link rel="StyleSheet" href="../../../book.css" type="text/css"/>
+</head>
+<body bgcolor="#FFFFFF">
+<h2>Adding and Removing Global Variables </h2>
+<p>The <a href="viewing_variables.htm">Variables</a> view can also display global variables used by the program. Right-click in the <a href="viewing_variables.htm">Variables</a> view and select the <b>Add Global Variables</b> menu option to open the <b>Global Variables</b> dialog. There you can select one or more global variables to display in the Variables view, clickiing <b>OK</b> when done. </p>
+<p align="center"><img src="../images/wnd_global_variables.png" alt="Global Variables window" width="359" height="452"></p>
+<p class="figure">Figure 1 - Global Variables selection dialog</p>
+<h4>Removing Global Variables</h4>
+<p>Right-click in the <a href="viewing_variables.htm">Variables</a> view and select the <b>Add Global Variables</b> menu option to open the <b>Global Variables</b> dialog. Locate and uncheckmark the global variable to stop displaying, then click <b>OK</b>. This removes the selected global variable from the variables list.</p>
+<h5>Other references</h5>
+<ul>
+  <li><a href="variables.htm">Variables and Expressions Overview</a></li>
+</ul>
+<div id="footer">Copyright &copy; 2010 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>
--- a/core/com.nokia.carbide.cpp.doc.user/html/debugger/variables/viewing_variables.htm	Wed Jul 07 15:29:48 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/debugger/variables/viewing_variables.htm	Fri Jul 09 09:43:10 2010 -0500
@@ -11,7 +11,7 @@
 <h2>Viewing Variables </h2>
 <p>The <b>Variables</b> view allows manipulation of project  variables and the variable hierarchy used in the source code. For example, you can change the variable format, change a variable value, add watch expressions, or add global variables. </p>
 <p>Figure 1 shows the Variables view with <b>Show Type Names</b> option enabled. The default view shows the variables list and include the Name and Value for all the variables within scope. In addition, when you select a variable its value is also shown in a different pane within the view.</p>
-<p align="center"><img src="../images/view_variables.png" width="583" height="262"></p>
+<p align="center"><img src="../images/view_variables.png" width="551" height="281"></p>
 <p class="figure">Figure 1 - Variables view </p>
 <h3>Variables view toolbar icons</h3>
 <p>The following commands appear on the Variables view toolbar: </p>
@@ -52,15 +52,16 @@
     <td>Click to remove all global variables from the variables list. </td>
   </tr>
   <tr>
-    <td><b>Menu</b></td>
+    <td><b>View Menu</b></td>
     <td><div align="center"><img src="../images/icon_menu_white.png" width="12" height="12"></div></td>
-    <td><p>Enables you to modifiy the <b>Layout</b> to change the view orientation between: horizontal, vertical, or variables pane only.</p>
+    <td><p>Enables you to modifiy the <b>Layout</b> to change the view orientation between: horizontal, vertical, or variables pane only and customize the columns shown in the view.</p>
+        <p align="center"><img src="../images/menu_view_variables_01.png" alt="View menu" width="373" height="158"></p>
         <p>In addition, use <b>Show All Variables</b> to toggle between showing only those variables that are in scope and live or   show all local variables, even if redundant. With this option on you will see all of the variables including the multiple defined variables like &ldquo;i&rdquo; for your loops  and ones that may no longer have accurate values.</p></td>
   </tr>
 </table>
 <h3>Variables view context menu options</h3>
 <p>Right-click in the <b>Variables</b> view to access the commands on the Variables view context menu.</p>
-<p align="center"><img src="../images/view_variables_menu_cmds.png" width="236" height="334"></p>
+<p align="center"><img src="../images/menu_view_variables_02.png" alt="Variables view context menu" width="424" height="344"></p>
 <p class="figure">Figure 2. Variables view context menu commands</p>
 <p>The  commands include: </p>
 <table width="100%"  border="0" cellpadding="2" cellspacing="0">
@@ -74,7 +75,8 @@
   </tr>
   <tr>
     <td><b>Copy Variables</b></td>
-    <td>Copies the selected variables to the clipboard.</td>
+    <td><p>Copies the selected variables to the clipboard.</p>
+        <p class="note"><strong>NOTE</strong> Only the selected variables visible in the Variables view are copied. Variables listed outside the boundary of the view are not in memory and can't be copied at this time.</p></td>
   </tr>
   <tr>
     <td><b>Enable</b></td>
@@ -85,60 +87,62 @@
     <td>Disables the selected variable.</td>
   </tr>
   <tr>
-    <td><b>Display as Array...</b></td>
-    <td>&nbsp;</td>
+    <td><b>Cast To Type...</b></td>
+    <td><p>Opens the <b>Cast to Type</b> dialog where you can assign a new type to the variable. Enter the type and click <strong>OK</strong>. </p>
+        <p>All cast variables are then shown using the <strong>Restore Original Type</strong> menu option making them easy to identify and restore later.</p>
+        <p align="center"><img src="../images/wnd_cast_to_type.png" alt="Cast To Type window" width="488" height="197"></p>
+        </td>
   </tr>
   <tr>
-    <td><b>Cast To Type...</b></td>
-    <td>Opens the <b>Cast to Type</b> dialog where you can assign a new type to the variable.</td>
-  </tr>
-  <tr>
-    <td><p><b>Restore Original Type</b></p>    </td>
-    <td>Resets the selected variable to the original type assigned by the program.</td>
+      <td><strong>Display As Array...</strong></td>
+      <td><p>Opens the <strong>Display as Array</strong> dialog where you can set array parameters to show the variables. Enter the <strong>Start index</strong> and <strong>Length</strong>, then click <strong>OK</strong> to update how the variables are shown in the Variables view.</p>
+        <p align="center"><img src="../images/wnd_display_as_array.png" alt="Display as Array" width="488" height="195"></p></td>
   </tr>
   <tr>
     <td><b>View Memory</b></td>
-    <td>Opens a <b>Memory</b> view on the selected variable so you can examine it.</td>
+    <td>Opens a <a href="../../reference/view_memory_wnd.htm">Memory</a> view on the selected variable so you can examine it.</td>
+  </tr>
+  <tr>
+      <td><b>Format</b></td>
+      <td><p>Change the selected variable's  display format. The default setting is Natural, or the format assigned when the variable is defined. For example, the decimal value of 256 would appear as:</p>
+              <ul>
+                  <li>Binary (<span class="code">0b100000</span>)</li>
+                  <li>Natural (<span class="code">256</span>)</li>
+                  <li>Decimal (<span class="code">256</span>)</li>
+                  <li>Hexadecimal (<span class="code">0x100</span>)</li>
+              </ul></td>
   </tr>
   <tr>
     <td><b>Find...</b></td>
-    <td>Opens a <b>Find</b> dialog to search for variables.</td>
+    <td><p>Opens a <b>Find</b> dialog to search for variables. Enter the variable to search for and click <strong>OK</strong>.</p>
+        <p align="center"><img src="../images/wnd_find_variables.png" alt="Find window" width="398" height="437"></p></td>
   </tr>
   <tr>
     <td><b>Change Value...</b></td>
     <td><p>Opens the <b>Set Value</b> dialog where you can modify the value assigned to the selected variable. Change the value and click <b>OK</b>.</p>
-    <p align="center"><img src="../images/wnd_set_value.png" width="401" height="214"></p></td>
+    <p align="center"><img src="../images/wnd_set_value.png" width="488" height="234"></p></td>
+  </tr>
+  <tr>
+      <td><b>Add Global Variables...</b></td>
+      <td>Select  to open the <a href="adding_variables.htm">Global Variables</a> dialog where you can select one or more global variables to display in the Variables view. Global variables appear at the top of the variables list. </td>
+  </tr>
+  <tr>
+      <td><b>Remove Global Variables</b></td>
+      <td>Remove the selected global variables from the Variables view.</td>
+  </tr>
+  <tr>
+      <td><b>Remove All Global Variables</b></td>
+      <td>Remove all  global variables from the Variables view.</td>
   </tr>
   <tr>
     <td><b>Add Watchpoint (C/C++)...</b></td>
-    <td>Opens the <a href="../watchpoints/setting_watchpoints.htm">Add Watchpoint</a> dialog enabling you to define a watchpoint on the variable.</td>
-  </tr>
-  <tr>
-    <td><b>Add Global Variables...</b></td>
-    <td>Select  to open the <a href="adding_variables.htm">Global Variables</a> dialog where you can select one or more global variables to display in the Variables view. Global variables appear at the top of the variables list. </td>
-  </tr>
-  <tr>
-    <td><b>Remove Global Variables</b></td>
-    <td>Remove the selected global variables from the Variables view.</td>
+    <td><p>Opens the <a href="../watchpoints/setting_watchpoints.htm">Add Watchpoint</a> dialog enabling you to define a watchpoint on the variable.</p>
+        <p align="center"><img src="../images/wnd_add_watchpoint.png" alt="Add Watchpoint window" width="238" height="253"></p></td>
   </tr>
   <tr>
-    <td><b>Remove All Global Variables</b></td>
-    <td>Remove all  global variables from the Variables view.</td>
-  </tr>
-  <tr>
-    <td><b>Create Watch Expression</b></td>
+    <td><b> Watch</b></td>
     <td>Creates a watchpoint on the selected variable and displays it in the <a href="../watchpoints/watchpoints.htm">Watchpoint</a> view. </td>
   </tr>
-  <tr>
-    <td><b>Format</b></td>
-    <td><p>Change the selected variable's  display format. The default setting is Natural, or the format assigned when the variable is defined. For example, the decimal value of 256 would appear as:</p>
-      <ul>
-        <li>Binary (<span class="code">0b100000</span>)</li>
-        <li>Natural (<span class="code">256</span>)</li>
-        <li>Decimal (<span class="code">256</span>)</li>
-        <li>Hexadecimal (<span class="code">0x100</span>)</li>
-    </ul>      </td>
-  </tr>
 </table>
 <h5>Other references</h5>
 <ul>
--- a/core/com.nokia.carbide.cpp.doc.user/html/debugger/watchpoints/setting_watchpoints.htm	Wed Jul 07 15:29:48 2010 -0500
+++ b/core/com.nokia.carbide.cpp.doc.user/html/debugger/watchpoints/setting_watchpoints.htm	Fri Jul 09 09:43:10 2010 -0500
@@ -12,7 +12,7 @@
 <p>You create a watchpoint to monitor a value in a specified memory location. The debugger halts program execution on the line of source code that triggered the watchpoint. This is different than a breakpoint, which halts program execution prior to executing the line of source code on which the breakpoint is set.</p>
 <h4>Setting watchpoints</h4>
 <p>Right-click in the <a href="../breakpoints/viewing_breakpoints.htm">Breakpoints</a> view and choose the  <b>Add Watchpoint (C/C++)...</b> command to open the <b>Add Watchpoint</b> window. A watchpoint suspends program execution when the memory location that you specify is accessed with a write or read operation and it's based on the access setting. Use the <b>Add Watchpoint</b> window to specify the  memory location, its memory size, unit size, and define whether the watchpoint  triggers on a read, write, or on both operations. Watchpoints can also be added directly in the <a href="../../reference/view_variables.htm">Variables</a>, <a href="PLUGINS_ROOT/org.eclipse.cdt.doc.user/reference/cdt_u_outline_view.htm">Outline</a>, and the <a href="../../reference/view_memory_wnd.htm">Memory Rendering</a> views.</p>
-<p align="center"><img src="../images/wnd_add_watchpoint.png" width="220" height="261"></p>
+<p align="center"><img src="../images/wnd_add_watchpoint.png" width="238" height="253"></p>
 <p align="center" class="figure">Figure 1. Add Watchpoint window </p>
 <h5>Table 1. Add Watchpoint options </h5>
   <table width="88%"  border="0" cellpadding="2" cellspacing="0">