Browse Source

Update docs

Miguel de Icaza 7 years ago
parent
commit
c3e45f7cbb
35 changed files with 226 additions and 129 deletions
  1. 1 1
      docfx/api/Mono.Terminal/Mono.Terminal.MainLoop.Condition.yml
  2. 3 0
      docfx/api/Mono.Terminal/Mono.Terminal.MainLoop.yml
  3. 9 15
      docfx/api/Terminal.Gui/Terminal.Gui.Application.yml
  4. 4 4
      docfx/api/Terminal.Gui/Terminal.Gui.Button.yml
  5. 6 4
      docfx/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.yml
  6. 1 1
      docfx/api/Terminal.Gui/Terminal.Gui.FrameView.yml
  7. 1 0
      docfx/api/Terminal.Gui/Terminal.Gui.ListView.yml
  8. 4 4
      docfx/api/Terminal.Gui/Terminal.Gui.Responder.yml
  9. 1 1
      docfx/api/Terminal.Gui/Terminal.Gui.Toplevel.yml
  10. 3 3
      docfx/api/Terminal.Gui/Terminal.Gui.View.yml
  11. 2 2
      docfx/api/Terminal.Gui/Terminal.Gui.Window.yml
  12. 1 1
      docs/api/Mono.Terminal.html
  13. 1 1
      docs/api/Mono.Terminal/Mono.Terminal.MainLoop.Condition.html
  14. 4 0
      docs/api/Mono.Terminal/Mono.Terminal.MainLoop.html
  15. 28 7
      docs/api/Terminal.Gui/Terminal.Gui.Application.html
  16. 4 4
      docs/api/Terminal.Gui/Terminal.Gui.Button.html
  17. 8 6
      docs/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html
  18. 1 1
      docs/api/Terminal.Gui/Terminal.Gui.FrameView.html
  19. 20 0
      docs/api/Terminal.Gui/Terminal.Gui.ListView.html
  20. 4 4
      docs/api/Terminal.Gui/Terminal.Gui.Responder.html
  21. 1 1
      docs/api/Terminal.Gui/Terminal.Gui.Toplevel.html
  22. 3 3
      docs/api/Terminal.Gui/Terminal.Gui.View.html
  23. 2 2
      docs/api/Terminal.Gui/Terminal.Gui.Window.html
  24. 0 0
      docs/manifest.json
  25. 7 7
      ecmadocs/en/Mono.Terminal/MainLoop+Condition.xml
  26. 4 1
      ecmadocs/en/Mono.Terminal/MainLoop.xml
  27. 31 9
      ecmadocs/en/Terminal.Gui/Application.xml
  28. 12 12
      ecmadocs/en/Terminal.Gui/Button.xml
  29. 10 6
      ecmadocs/en/Terminal.Gui/ConsoleDriver.xml
  30. 2 2
      ecmadocs/en/Terminal.Gui/FrameView.xml
  31. 22 1
      ecmadocs/en/Terminal.Gui/ListView.xml
  32. 9 9
      ecmadocs/en/Terminal.Gui/Responder.xml
  33. 3 3
      ecmadocs/en/Terminal.Gui/Toplevel.xml
  34. 9 9
      ecmadocs/en/Terminal.Gui/View.xml
  35. 5 5
      ecmadocs/en/Terminal.Gui/Window.xml

+ 1 - 1
docfx/api/Mono.Terminal/Mono.Terminal.MainLoop.Condition.yml

@@ -18,7 +18,7 @@ items:
   assemblies:
   - Terminal.Gui
   namespace: Mono.Terminal
-  summary: Condition on which to wake up from file descriptor activity
+  summary: Condition on which to wake up from file descriptor activity.  These match the Linux/BSD poll definitions.
   syntax:
     content: >-
       [System.Flags]

+ 3 - 0
docfx/api/Mono.Terminal/Mono.Terminal.MainLoop.yml

@@ -27,6 +27,9 @@ items:
   summary: >-
     Simple main loop implementation that can be used to monitor
                   file descriptor, run timers and idle handlers.
+  remarks: >-
+    Monitoring of file descriptors is only available on Unix, there
+                  does not seem to be a way of supporting this on Windows.
   syntax:
     content: public class MainLoop
   inheritance:

+ 9 - 15
docfx/api/Terminal.Gui/Terminal.Gui.Application.yml

@@ -68,15 +68,17 @@ items:
   assemblies:
   - Terminal.Gui
   namespace: Terminal.Gui
+  summary: 'Building block API: Prepares the provided toplevel for execution.'
+  remarks: "This method prepares the provided toplevel for running with the focus,\n             it adds this to the list of toplevels, sets up the mainloop to process the \n             event, lays out the subviews, focuses the first element, and draws the\n             toplevel in the screen.   This is usually followed by executing\n             the <xref href=\"Terminal.Gui.Application.RunLoop(Terminal.Gui.Application.RunState,System.Boolean)\"></xref> method, and then the <xref href=\"Terminal.Gui.Application.End(Terminal.Gui.Application.RunState)\"></xref> method upon termination which will\n              undo these changes."
   syntax:
     content: public static Terminal.Gui.Application.RunState Begin (Terminal.Gui.Toplevel toplevel);
     parameters:
     - id: toplevel
       type: Terminal.Gui.Toplevel
-      description: To be added.
+      description: Toplevel to prepare execution for.
     return:
       type: Terminal.Gui.Application+RunState
-      description: To be added.
+      description: The runstate handle that needs to be passed to the End() method upon completion.
   overload: Terminal.Gui.Application.Begin*
   exceptions: []
 - uid: Terminal.Gui.Application.Current
@@ -130,6 +132,7 @@ items:
   assemblies:
   - Terminal.Gui
   namespace: Terminal.Gui
+  summary: 'Building block API: completes the exection of a Toplevel that was started with Begin.'
   syntax:
     content: public static void End (Terminal.Gui.Application.RunState rs);
     parameters:
@@ -329,16 +332,7 @@ items:
   - Terminal.Gui
   namespace: Terminal.Gui
   summary: Runs the main loop on the given container.
-  remarks: >-
-    <p>
-                    This method is used to start processing events
-                    for the main application, but it is also used to
-                    run modal dialog boxes.
-                  </p>
-        <p>
-                    To make a toplevel stop execution, set the "Running"
-                    property to false.
-                  </p>
+  remarks: "<p>\n                This method is used to start processing events\n                for the main application, but it is also used to\n                run modal dialog boxes.\n              </p>\n    <p>\n                To make a toplevel stop execution, set the \"Running\"\n                property to false.\n              </p>\n    <p>\n                This is equivalent to calling Begin on the toplevel view, followed by RunLoop with the\n                returned value, and then calling end on the return value.\n              </p>\n    <p>\n                Alternatively, if your program needs to control the main loop and needs to \n                process events manually, you can invoke Begin to set things up manually and then\n                repeatedly call RunLoop with the wait parameter set to false.   By doing this\n                the RunLoop method will only process any pending events, timers, idle handlers and\n                then return control immediately.\n              </p>"
   syntax:
     content: public static void Run (Terminal.Gui.Toplevel view);
     parameters:
@@ -359,7 +353,7 @@ items:
   assemblies:
   - Terminal.Gui
   namespace: Terminal.Gui
-  summary: Runs the main loop for the created dialog
+  summary: 'Building block API: Runs the main loop for the created dialog'
   remarks: >-
     Use the wait parameter to control whether this is a
                   blocking or non-blocking call.
@@ -368,10 +362,10 @@ items:
     parameters:
     - id: state
       type: Terminal.Gui.Application+RunState
-      description: To be added.
+      description: The state returned by the Begin method.
     - id: wait
       type: System.Boolean
-      description: To be added.
+      description: By default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events.
   overload: Terminal.Gui.Application.RunLoop*
   exceptions: []
 - uid: Terminal.Gui.Application.Top

+ 4 - 4
docfx/api/Terminal.Gui/Terminal.Gui.Button.yml

@@ -107,7 +107,7 @@ items:
     The size of the button is computed based on the
                   text length.   This button is not a default button.
   syntax:
-    content: public Button (string s);
+    content: public Button (string text);
     parameters:
     - id: s
       type: System.String
@@ -134,7 +134,7 @@ items:
                   decoration is used, and the enter key on a
                   dialog would implicitly activate this button.
   syntax:
-    content: public Button (string s, bool is_default);
+    content: public Button (string text, bool is_default);
     parameters:
     - id: s
       type: System.String
@@ -163,7 +163,7 @@ items:
     The size of the button is computed based on the
                   text length.   This button is not a default button.
   syntax:
-    content: public Button (int x, int y, string s);
+    content: public Button (int x, int y, string text);
     parameters:
     - id: x
       type: System.Int32
@@ -196,7 +196,7 @@ items:
                   decoration is used, and the enter key on a
                   dialog would implicitly activate this button.
   syntax:
-    content: public Button (int x, int y, string s, bool is_default);
+    content: public Button (int x, int y, string text, bool is_default);
     parameters:
     - id: x
       type: System.Int32

+ 6 - 4
docfx/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.yml

@@ -282,18 +282,19 @@ items:
   assemblies:
   - Terminal.Gui
   namespace: Terminal.Gui
+  summary: Draws a frame on the specified region with the specified padding around the frame.
   syntax:
     content: public virtual void DrawFrame (Terminal.Gui.Rect region, int padding, bool fill);
     parameters:
     - id: region
       type: Terminal.Gui.Rect
-      description: To be added.
+      description: Region where the frame will be drawn..
     - id: padding
       type: System.Int32
-      description: To be added.
+      description: Padding to add on the sides.
     - id: fill
       type: System.Boolean
-      description: To be added.
+      description: If set to <code>true</code> it will clear the contents with the current color, otherwise the contents will be left untouched.
   overload: Terminal.Gui.ConsoleDriver.DrawFrame*
   exceptions: []
 - uid: Terminal.Gui.ConsoleDriver.End
@@ -547,12 +548,13 @@ items:
   assemblies:
   - Terminal.Gui
   namespace: Terminal.Gui
+  summary: Selects the specified attribute as the attribute to use for future calls to AddRune, AddString.
   syntax:
     content: public abstract void SetAttribute (Terminal.Gui.Attribute c);
     parameters:
     - id: c
       type: Terminal.Gui.Attribute
-      description: To be added.
+      description: C.
   overload: Terminal.Gui.ConsoleDriver.SetAttribute*
   exceptions: []
 - uid: Terminal.Gui.ConsoleDriver.SetColors(System.Int16,System.Int16)

+ 1 - 1
docfx/api/Terminal.Gui/Terminal.Gui.FrameView.yml

@@ -153,7 +153,7 @@ items:
   namespace: Terminal.Gui
   summary: Removes a widget from this container.
   syntax:
-    content: public virtual void Remove (Terminal.Gui.View view);
+    content: public override void Remove (Terminal.Gui.View view);
     parameters:
     - id: view
       type: Terminal.Gui.View

+ 1 - 0
docfx/api/Terminal.Gui/Terminal.Gui.ListView.yml

@@ -25,6 +25,7 @@ items:
   - Terminal.Gui
   namespace: Terminal.Gui
   summary: ListView widget renders a list of data.
+  remarks: "<p>\n              The ListView displays lists of data and allows the user to scroll through the data\n              and optionally mark elements of the list (controlled by the AllowsMark property).  \n            </p>\n    <p>\n              The ListView can either render an arbitrary IList object (for example, arrays, List<T>\n              and other collections) which are drawn by drawing the string/ustring contents or the \n              result of calling ToString().   Alternatively, you can provide you own IListDataSource\n              object that gives you full control of what is rendered.\n            </p>\n    <p>\n              The ListView can display any object that implements the System.Collection.IList interface,\n              string values are converted into ustring values before rendering, and other values are\n              converted into ustrings by calling ToString() and then converting to ustring.\n            </p>\n    <p>\n              If you must change the contents of the ListView, set the Source property (when you are\n              providing your own rendering via the IListDataSource implementation) or call SetSource\n              when you are providing an IList.\n            </p>"
   syntax:
     content: 'public class ListView : Terminal.Gui.View'
   inheritance:

+ 4 - 4
docfx/api/Terminal.Gui/Terminal.Gui.Responder.yml

@@ -96,11 +96,11 @@ items:
   namespace: Terminal.Gui
   summary: Method invoked when a mouse event is generated
   syntax:
-    content: public virtual bool MouseEvent (Terminal.Gui.MouseEvent me);
+    content: public virtual bool MouseEvent (Terminal.Gui.MouseEvent mouseEvent);
     parameters:
     - id: me
       type: Terminal.Gui.MouseEvent
-      description: Me.
+      description: To be added.
     return:
       type: System.Boolean
       description: <code>true</code>, if the event was handled, <code>false</code> otherwise.
@@ -138,7 +138,7 @@ items:
                    keypress when they have the focus.
                  </p>
   syntax:
-    content: public virtual bool ProcessColdKey (Terminal.Gui.KeyEvent kb);
+    content: public virtual bool ProcessColdKey (Terminal.Gui.KeyEvent keyEvent);
     parameters:
     - id: kb
       type: Terminal.Gui.KeyEvent
@@ -207,7 +207,7 @@ items:
                   chance to process the keystroke.
   remarks: "<p>\n                Views can override this method if they are\n                interested in processing the given keystroke.\n                If they consume the keystroke, they must\n                return true to stop the keystroke from being\n                processed by other widgets or consumed by the\n                widget engine.    If they return false, the\n                keystroke will be passed using the ProcessColdKey\n                method to other views to process.\n              </p>\n    <p>\n                The View implementation does nothing but return false,\n                so it is not necessary to call base.ProcessKey if you \n                derive directly from View, but you should if you derive\n                other View subclasses.\n              </p>"
   syntax:
-    content: public virtual bool ProcessKey (Terminal.Gui.KeyEvent kb);
+    content: public virtual bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);
     parameters:
     - id: kb
       type: Terminal.Gui.KeyEvent

+ 1 - 1
docfx/api/Terminal.Gui/Terminal.Gui.Toplevel.yml

@@ -154,7 +154,7 @@ items:
   - Terminal.Gui
   namespace: Terminal.Gui
   syntax:
-    content: public override bool ProcessKey (Terminal.Gui.KeyEvent kb);
+    content: public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);
     parameters:
     - id: kb
       type: Terminal.Gui.KeyEvent

+ 3 - 3
docfx/api/Terminal.Gui/Terminal.Gui.View.yml

@@ -816,7 +816,7 @@ items:
   - Terminal.Gui
   namespace: Terminal.Gui
   syntax:
-    content: public override bool ProcessColdKey (Terminal.Gui.KeyEvent kb);
+    content: public override bool ProcessColdKey (Terminal.Gui.KeyEvent keyEvent);
     parameters:
     - id: kb
       type: Terminal.Gui.KeyEvent
@@ -839,7 +839,7 @@ items:
   - Terminal.Gui
   namespace: Terminal.Gui
   syntax:
-    content: public override bool ProcessHotKey (Terminal.Gui.KeyEvent kb);
+    content: public override bool ProcessHotKey (Terminal.Gui.KeyEvent keyEvent);
     parameters:
     - id: kb
       type: Terminal.Gui.KeyEvent
@@ -862,7 +862,7 @@ items:
   - Terminal.Gui
   namespace: Terminal.Gui
   syntax:
-    content: public override bool ProcessKey (Terminal.Gui.KeyEvent kb);
+    content: public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);
     parameters:
     - id: kb
       type: Terminal.Gui.KeyEvent

+ 2 - 2
docfx/api/Terminal.Gui/Terminal.Gui.Window.yml

@@ -209,7 +209,7 @@ items:
   - Terminal.Gui
   namespace: Terminal.Gui
   syntax:
-    content: public override bool MouseEvent (Terminal.Gui.MouseEvent me);
+    content: public override bool MouseEvent (Terminal.Gui.MouseEvent mouseEvent);
     parameters:
     - id: me
       type: Terminal.Gui.MouseEvent
@@ -253,7 +253,7 @@ items:
   namespace: Terminal.Gui
   summary: Removes a widget from this container.
   syntax:
-    content: public virtual void Remove (Terminal.Gui.View view);
+    content: public override void Remove (Terminal.Gui.View view);
     parameters:
     - id: view
       type: Terminal.Gui.View

+ 1 - 1
docs/api/Mono.Terminal.html

@@ -83,7 +83,7 @@
     <h3 id="enums">Enums
   </h3>
       <h4><a class="xref" href="Mono.Terminal/Mono.Terminal.MainLoop.Condition.html">MainLoop.Condition</a></h4>
-      <section><p>Condition on which to wake up from file descriptor activity</p>
+      <section><p>Condition on which to wake up from file descriptor activity.  These match the Linux/BSD poll definitions.</p>
 </section>
 </article>
           </div>

+ 1 - 1
docs/api/Mono.Terminal/Mono.Terminal.MainLoop.Condition.html

@@ -72,7 +72,7 @@
   
   <h1 id="Mono_Terminal_MainLoop_Condition" data-uid="Mono.Terminal.MainLoop.Condition">Enum MainLoop.Condition
   </h1>
-  <div class="markdown level0 summary"><p>Condition on which to wake up from file descriptor activity</p>
+  <div class="markdown level0 summary"><p>Condition on which to wake up from file descriptor activity.  These match the Linux/BSD poll definitions.</p>
 </div>
   <div class="markdown level0 conceptual"></div>
   <h6><strong>Namespace</strong>: <a class="xref" href="../Mono.Terminal.html">Mono.Terminal</a></h6>

+ 4 - 0
docs/api/Mono.Terminal/Mono.Terminal.MainLoop.html

@@ -87,6 +87,10 @@
   <div class="codewrapper">
     <pre><code class="lang-csharp hljs">public class MainLoop</code></pre>
   </div>
+  <h5 id="Mono_Terminal_MainLoop_remarks"><strong>Remarks</strong></h5>
+  <div class="markdown level0 remarks"><p>Monitoring of file descriptors is only available on Unix, there
+              does not seem to be a way of supporting this on Windows.</p>
+</div>
   <h3 id="constructors">Constructors
   </h3>
   

+ 28 - 7
docs/api/Terminal.Gui/Terminal.Gui.Application.html

@@ -280,7 +280,8 @@
   
   <a id="Terminal_Gui_Application_Begin_" data-uid="Terminal.Gui.Application.Begin*"></a>
   <h4 id="Terminal_Gui_Application_Begin_Terminal_Gui_Toplevel_" data-uid="Terminal.Gui.Application.Begin(Terminal.Gui.Toplevel)">Begin(Toplevel)</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Building block API: Prepares the provided toplevel for execution.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -299,7 +300,7 @@
       <tr>
         <td><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></td>
         <td><span class="parametername">toplevel</span></td>
-        <td><p>To be added.</p>
+        <td><p>Toplevel to prepare execution for.</p>
 </td>
       </tr>
     </tbody>
@@ -315,16 +316,25 @@
     <tbody>
       <tr>
         <td></td>
-        <td><p>To be added.</p>
+        <td><p>The runstate handle that needs to be passed to the End() method upon completion.</p>
 </td>
       </tr>
     </tbody>
   </table>
+  <h5 id="Terminal_Gui_Application_Begin_Terminal_Gui_Toplevel__remarks">Remarks</h5>
+  <div class="markdown level1 remarks"><p>This method prepares the provided toplevel for running with the focus,
+             it adds this to the list of toplevels, sets up the mainloop to process the 
+             event, lays out the subviews, focuses the first element, and draws the
+             toplevel in the screen.   This is usually followed by executing
+             the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_RunLoop_Terminal_Gui_Application_RunState_System_Boolean_">RunLoop(Application+RunState, Boolean)</a> method, and then the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_End_Terminal_Gui_Application_RunState_">End(Application+RunState)</a> method upon termination which will
+              undo these changes.</p>
+</div>
   
   
   <a id="Terminal_Gui_Application_End_" data-uid="Terminal.Gui.Application.End*"></a>
   <h4 id="Terminal_Gui_Application_End_Terminal_Gui_Application_RunState_" data-uid="Terminal.Gui.Application.End(Terminal.Gui.Application.RunState)">End(Application+RunState)</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Building block API: completes the exection of a Toplevel that was started with Begin.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -504,12 +514,23 @@
     <p>
                 To make a toplevel stop execution, set the &quot;Running&quot;
                 property to false.
+              </p>
+    <p>
+                This is equivalent to calling Begin on the toplevel view, followed by RunLoop with the
+                returned value, and then calling end on the return value.
+              </p>
+    <p>
+                Alternatively, if your program needs to control the main loop and needs to 
+                process events manually, you can invoke Begin to set things up manually and then
+                repeatedly call RunLoop with the wait parameter set to false.   By doing this
+                the RunLoop method will only process any pending events, timers, idle handlers and
+                then return control immediately.
               </p></div>
   
   
   <a id="Terminal_Gui_Application_RunLoop_" data-uid="Terminal.Gui.Application.RunLoop*"></a>
   <h4 id="Terminal_Gui_Application_RunLoop_Terminal_Gui_Application_RunState_System_Boolean_" data-uid="Terminal.Gui.Application.RunLoop(Terminal.Gui.Application.RunState,System.Boolean)">RunLoop(Application+RunState, Boolean)</h4>
-  <div class="markdown level1 summary"><p>Runs the main loop for the created dialog</p>
+  <div class="markdown level1 summary"><p>Building block API: Runs the main loop for the created dialog</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
@@ -529,13 +550,13 @@
       <tr>
         <td></td>
         <td><span class="parametername">state</span></td>
-        <td><p>To be added.</p>
+        <td><p>The state returned by the Begin method.</p>
 </td>
       </tr>
       <tr>
         <td><span class="xref">System.Boolean</span></td>
         <td><span class="parametername">wait</span></td>
-        <td><p>To be added.</p>
+        <td><p>By default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events.</p>
 </td>
       </tr>
     </tbody>

+ 4 - 4
docs/api/Terminal.Gui/Terminal.Gui.Button.html

@@ -243,7 +243,7 @@
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public Button (string s);</code></pre>
+    <pre><code class="lang-csharp hljs">public Button (string text);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -277,7 +277,7 @@
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public Button (string s, bool is_default);</code></pre>
+    <pre><code class="lang-csharp hljs">public Button (string text, bool is_default);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -318,7 +318,7 @@
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public Button (int x, int y, string s);</code></pre>
+    <pre><code class="lang-csharp hljs">public Button (int x, int y, string text);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -364,7 +364,7 @@
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public Button (int x, int y, string s, bool is_default);</code></pre>
+    <pre><code class="lang-csharp hljs">public Button (int x, int y, string text, bool is_default);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">

+ 8 - 6
docs/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html

@@ -657,7 +657,8 @@
   
   <a id="Terminal_Gui_ConsoleDriver_DrawFrame_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame*"></a>
   <h4 id="Terminal_Gui_ConsoleDriver_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_" data-uid="Terminal.Gui.ConsoleDriver.DrawFrame(Terminal.Gui.Rect,System.Int32,System.Boolean)">DrawFrame(Rect, Int32, Boolean)</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Draws a frame on the specified region with the specified padding around the frame.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -676,19 +677,19 @@
       <tr>
         <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
         <td><span class="parametername">region</span></td>
-        <td><p>To be added.</p>
+        <td><p>Region where the frame will be drawn..</p>
 </td>
       </tr>
       <tr>
         <td><span class="xref">System.Int32</span></td>
         <td><span class="parametername">padding</span></td>
-        <td><p>To be added.</p>
+        <td><p>Padding to add on the sides.</p>
 </td>
       </tr>
       <tr>
         <td><span class="xref">System.Boolean</span></td>
         <td><span class="parametername">fill</span></td>
-        <td><p>To be added.</p>
+        <td><p>If set to <code>true</code> it will clear the contents with the current color, otherwise the contents will be left untouched.</p>
 </td>
       </tr>
     </tbody>
@@ -833,7 +834,8 @@
   
   <a id="Terminal_Gui_ConsoleDriver_SetAttribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute*"></a>
   <h4 id="Terminal_Gui_ConsoleDriver_SetAttribute_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.ConsoleDriver.SetAttribute(Terminal.Gui.Attribute)">SetAttribute(Attribute)</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Selects the specified attribute as the attribute to use for future calls to AddRune, AddString.</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
@@ -852,7 +854,7 @@
       <tr>
         <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
         <td><span class="parametername">c</span></td>
-        <td><p>To be added.</p>
+        <td><p>C.</p>
 </td>
       </tr>
     </tbody>

+ 1 - 1
docs/api/Terminal.Gui/Terminal.Gui.FrameView.html

@@ -364,7 +364,7 @@
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public virtual void Remove (Terminal.Gui.View view);</code></pre>
+    <pre><code class="lang-csharp hljs">public override void Remove (Terminal.Gui.View view);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">

+ 20 - 0
docs/api/Terminal.Gui/Terminal.Gui.ListView.html

@@ -226,6 +226,26 @@
   <div class="codewrapper">
     <pre><code class="lang-csharp hljs">public class ListView : Terminal.Gui.View</code></pre>
   </div>
+  <h5 id="Terminal_Gui_ListView_remarks"><strong>Remarks</strong></h5>
+  <div class="markdown level0 remarks"><p>
+              The ListView displays lists of data and allows the user to scroll through the data
+              and optionally mark elements of the list (controlled by the AllowsMark property).<br>            </p>
+    <p>
+              The ListView can either render an arbitrary IList object (for example, arrays, List<t>
+              and other collections) which are drawn by drawing the string/ustring contents or the 
+              result of calling ToString().   Alternatively, you can provide you own IListDataSource
+              object that gives you full control of what is rendered.
+            <p>
+    <p>
+              The ListView can display any object that implements the System.Collection.IList interface,
+              string values are converted into ustring values before rendering, and other values are
+              converted into ustrings by calling ToString() and then converting to ustring.
+            </p>
+    <p>
+              If you must change the contents of the ListView, set the Source property (when you are
+              providing your own rendering via the IListDataSource implementation) or call SetSource
+              when you are providing an IList.
+            </p></t></div>
   <h3 id="constructors">Constructors
   </h3>
   

+ 4 - 4
docs/api/Terminal.Gui/Terminal.Gui.Responder.html

@@ -163,7 +163,7 @@
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public virtual bool MouseEvent (Terminal.Gui.MouseEvent me);</code></pre>
+    <pre><code class="lang-csharp hljs">public virtual bool MouseEvent (Terminal.Gui.MouseEvent mouseEvent);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -178,7 +178,7 @@
       <tr>
         <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
         <td><span class="parametername">me</span></td>
-        <td><p>Me.</p>
+        <td><p>To be added.</p>
 </td>
       </tr>
     </tbody>
@@ -211,7 +211,7 @@
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public virtual bool ProcessColdKey (Terminal.Gui.KeyEvent kb);</code></pre>
+    <pre><code class="lang-csharp hljs">public virtual bool ProcessColdKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -333,7 +333,7 @@
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public virtual bool ProcessKey (Terminal.Gui.KeyEvent kb);</code></pre>
+    <pre><code class="lang-csharp hljs">public virtual bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">

+ 1 - 1
docs/api/Terminal.Gui/Terminal.Gui.Toplevel.html

@@ -363,7 +363,7 @@
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent kb);</code></pre>
+    <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">

+ 3 - 3
docs/api/Terminal.Gui/Terminal.Gui.View.html

@@ -1142,7 +1142,7 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public override bool ProcessColdKey (Terminal.Gui.KeyEvent kb);</code></pre>
+    <pre><code class="lang-csharp hljs">public override bool ProcessColdKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -1186,7 +1186,7 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public override bool ProcessHotKey (Terminal.Gui.KeyEvent kb);</code></pre>
+    <pre><code class="lang-csharp hljs">public override bool ProcessHotKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -1230,7 +1230,7 @@ public System.Collections.IEnumerator GetEnumerator ();</code></pre>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent kb);</code></pre>
+    <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">

+ 2 - 2
docs/api/Terminal.Gui/Terminal.Gui.Window.html

@@ -441,7 +441,7 @@
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.Gui.MouseEvent me);</code></pre>
+    <pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.Gui.MouseEvent mouseEvent);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -514,7 +514,7 @@
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public virtual void Remove (Terminal.Gui.View view);</code></pre>
+    <pre><code class="lang-csharp hljs">public override void Remove (Terminal.Gui.View view);</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">

File diff suppressed because it is too large
+ 0 - 0
docs/manifest.json


+ 7 - 7
ecmadocs/en/Mono.Terminal/MainLoop+Condition.xml

@@ -15,14 +15,14 @@
   </Attributes>
   <Docs>
     <summary>
-              Condition on which to wake up from file descriptor activity
+              Condition on which to wake up from file descriptor activity.  These match the Linux/BSD poll definitions.
             </summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
     <Member MemberName="PollErr">
       <MemberSignature Language="C#" Value="PollErr" />
-      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollErr = int32(8)" />
+      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollErr = int16(8)" />
       <MemberType>Field</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -38,7 +38,7 @@
     </Member>
     <Member MemberName="PollHup">
       <MemberSignature Language="C#" Value="PollHup" />
-      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollHup = int32(16)" />
+      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollHup = int16(16)" />
       <MemberType>Field</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -54,7 +54,7 @@
     </Member>
     <Member MemberName="PollIn">
       <MemberSignature Language="C#" Value="PollIn" />
-      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollIn = int32(1)" />
+      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollIn = int16(1)" />
       <MemberType>Field</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -70,7 +70,7 @@
     </Member>
     <Member MemberName="PollNval">
       <MemberSignature Language="C#" Value="PollNval" />
-      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollNval = int32(32)" />
+      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollNval = int16(32)" />
       <MemberType>Field</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -86,7 +86,7 @@
     </Member>
     <Member MemberName="PollOut">
       <MemberSignature Language="C#" Value="PollOut" />
-      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollOut = int32(2)" />
+      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollOut = int16(4)" />
       <MemberType>Field</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -102,7 +102,7 @@
     </Member>
     <Member MemberName="PollPri">
       <MemberSignature Language="C#" Value="PollPri" />
-      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollPri = int32(4)" />
+      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype Mono.Terminal.MainLoop/Condition PollPri = int16(2)" />
       <MemberType>Field</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>

+ 4 - 1
ecmadocs/en/Mono.Terminal/MainLoop.xml

@@ -14,7 +14,10 @@
               Simple main loop implementation that can be used to monitor
               file descriptor, run timers and idle handlers.
             </summary>
-    <remarks>To be added.</remarks>
+    <remarks>
+              Monitoring of file descriptors is only available on Unix, there
+              does not seem to be a way of supporting this on Windows.
+            </remarks>
   </Docs>
   <Members>
     <Member MemberName=".ctor">

+ 31 - 9
ecmadocs/en/Terminal.Gui/Application.xml

@@ -56,10 +56,19 @@
         <Parameter Name="toplevel" Type="Terminal.Gui.Toplevel" />
       </Parameters>
       <Docs>
-        <param name="toplevel">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="toplevel">Toplevel to prepare execution for.</param>
+        <summary>
+            Building block API: Prepares the provided toplevel for execution.
+            </summary>
+        <returns>The runstate handle that needs to be passed to the End() method upon completion.</returns>
+        <remarks>
+             This method prepares the provided toplevel for running with the focus,
+             it adds this to the list of toplevels, sets up the mainloop to process the 
+             event, lays out the subviews, focuses the first element, and draws the
+             toplevel in the screen.   This is usually followed by executing
+             the <see cref="M:Terminal.Gui.Application.RunLoop(Terminal.Gui.Application.RunState,System.Boolean)" /> method, and then the <see cref="M:Terminal.Gui.Application.End(Terminal.Gui.Application.RunState)" /> method upon termination which will
+              undo these changes.
+            </remarks>
       </Docs>
     </Member>
     <Member MemberName="Current">
@@ -112,7 +121,9 @@
       </Parameters>
       <Docs>
         <param name="rs">To be added.</param>
-        <summary>To be added.</summary>
+        <summary>
+            Building block API: completes the exection of a Toplevel that was started with Begin.
+            </summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -314,6 +325,17 @@
                 To make a toplevel stop execution, set the "Running"
                 property to false.
               </para>
+          <para>
+                This is equivalent to calling Begin on the toplevel view, followed by RunLoop with the
+                returned value, and then calling end on the return value.
+              </para>
+          <para>
+                Alternatively, if your program needs to control the main loop and needs to 
+                process events manually, you can invoke Begin to set things up manually and then
+                repeatedly call RunLoop with the wait parameter set to false.   By doing this
+                the RunLoop method will only process any pending events, timers, idle handlers and
+                then return control immediately.
+              </para>
         </remarks>
       </Docs>
     </Member>
@@ -332,14 +354,14 @@
         <Parameter Name="wait" Type="System.Boolean" />
       </Parameters>
       <Docs>
-        <param name="state">To be added.</param>
-        <param name="wait">To be added.</param>
+        <param name="state">The state returned by the Begin method.</param>
+        <param name="wait">By default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events.</param>
         <summary>
-              Runs the main loop for the created dialog
+              Building block API: Runs the main loop for the created dialog
             </summary>
         <remarks>
               Use the wait parameter to control whether this is a
-              blocking or non-blocking call.
+              blocking or non-blocking call.   
             </remarks>
       </Docs>
     </Member>

+ 12 - 12
ecmadocs/en/Terminal.Gui/Button.xml

@@ -28,8 +28,8 @@
   </Docs>
   <Members>
     <Member MemberName=".ctor">
-      <MemberSignature Language="C#" Value="public Button (string s);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string s) cil managed" />
+      <MemberSignature Language="C#" Value="public Button (string text);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string text) cil managed" />
       <MemberType>Constructor</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -38,7 +38,7 @@
         <Parameter Name="s" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="s">To be added.</param>
+        <param name="text">To be added.</param>
         <summary>
               Public constructor, creates a button based on
               the given text at position 0,0
@@ -50,8 +50,8 @@
       </Docs>
     </Member>
     <Member MemberName=".ctor">
-      <MemberSignature Language="C#" Value="public Button (string s, bool is_default);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string s, bool is_default) cil managed" />
+      <MemberSignature Language="C#" Value="public Button (string text, bool is_default);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string text, bool is_default) cil managed" />
       <MemberType>Constructor</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -61,7 +61,7 @@
         <Parameter Name="is_default" Type="System.Boolean" />
       </Parameters>
       <Docs>
-        <param name="s">To be added.</param>
+        <param name="text">To be added.</param>
         <param name="is_default">To be added.</param>
         <summary>
               Public constructor, creates a button based on
@@ -75,8 +75,8 @@
       </Docs>
     </Member>
     <Member MemberName=".ctor">
-      <MemberSignature Language="C#" Value="public Button (int x, int y, string s);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 x, int32 y, string s) cil managed" />
+      <MemberSignature Language="C#" Value="public Button (int x, int y, string text);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 x, int32 y, string text) cil managed" />
       <MemberType>Constructor</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -89,7 +89,7 @@
       <Docs>
         <param name="x">To be added.</param>
         <param name="y">To be added.</param>
-        <param name="s">To be added.</param>
+        <param name="text">To be added.</param>
         <summary>
               Public constructor, creates a button based on
               the given text at the given position.
@@ -101,8 +101,8 @@
       </Docs>
     </Member>
     <Member MemberName=".ctor">
-      <MemberSignature Language="C#" Value="public Button (int x, int y, string s, bool is_default);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 x, int32 y, string s, bool is_default) cil managed" />
+      <MemberSignature Language="C#" Value="public Button (int x, int y, string text, bool is_default);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 x, int32 y, string text, bool is_default) cil managed" />
       <MemberType>Constructor</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -116,7 +116,7 @@
       <Docs>
         <param name="x">To be added.</param>
         <param name="y">To be added.</param>
-        <param name="s">To be added.</param>
+        <param name="text">To be added.</param>
         <param name="is_default">To be added.</param>
         <summary>
               Public constructor, creates a button based on

+ 10 - 6
ecmadocs/en/Terminal.Gui/ConsoleDriver.xml

@@ -229,10 +229,12 @@
         <Parameter Name="fill" Type="System.Boolean" />
       </Parameters>
       <Docs>
-        <param name="region">To be added.</param>
-        <param name="padding">To be added.</param>
-        <param name="fill">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="region">Region where the frame will be drawn..</param>
+        <param name="padding">Padding to add on the sides.</param>
+        <param name="fill">If set to <c>true</c> it will clear the contents with the current color, otherwise the contents will be left untouched.</param>
+        <summary>
+            Draws a frame on the specified region with the specified padding around the frame.
+            </summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -472,8 +474,10 @@
         <Parameter Name="c" Type="Terminal.Gui.Attribute" />
       </Parameters>
       <Docs>
-        <param name="c">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="c">C.</param>
+        <summary>
+            Selects the specified attribute as the attribute to use for future calls to AddRune, AddString.
+            </summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

+ 2 - 2
ecmadocs/en/Terminal.Gui/FrameView.xml

@@ -78,8 +78,8 @@
       </Docs>
     </Member>
     <Member MemberName="Remove">
-      <MemberSignature Language="C#" Value="public virtual void Remove (Terminal.Gui.View view);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Remove(class Terminal.Gui.View view) cil managed" />
+      <MemberSignature Language="C#" Value="public override void Remove (Terminal.Gui.View view);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Remove(class Terminal.Gui.View view) cil managed" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>

+ 22 - 1
ecmadocs/en/Terminal.Gui/ListView.xml

@@ -13,7 +13,28 @@
     <summary>
             ListView widget renders a list of data.
             </summary>
-    <remarks>To be added.</remarks>
+    <remarks>
+      <para>
+              The ListView displays lists of data and allows the user to scroll through the data
+              and optionally mark elements of the list (controlled by the AllowsMark property).  
+            </para>
+      <para>
+              The ListView can either render an arbitrary IList object (for example, arrays, List&lt;T&gt;
+              and other collections) which are drawn by drawing the string/ustring contents or the 
+              result of calling ToString().   Alternatively, you can provide you own IListDataSource
+              object that gives you full control of what is rendered.
+            </para>
+      <para>
+              The ListView can display any object that implements the System.Collection.IList interface,
+              string values are converted into ustring values before rendering, and other values are
+              converted into ustrings by calling ToString() and then converting to ustring.
+            </para>
+      <para>
+              If you must change the contents of the ListView, set the Source property (when you are
+              providing your own rendering via the IListDataSource implementation) or call SetSource
+              when you are providing an IList.
+            </para>
+    </remarks>
   </Docs>
   <Members>
     <Member MemberName=".ctor">

+ 9 - 9
ecmadocs/en/Terminal.Gui/Responder.xml

@@ -60,8 +60,8 @@
       </Docs>
     </Member>
     <Member MemberName="MouseEvent">
-      <MemberSignature Language="C#" Value="public virtual bool MouseEvent (Terminal.Gui.MouseEvent me);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool MouseEvent(valuetype Terminal.Gui.MouseEvent me) cil managed" />
+      <MemberSignature Language="C#" Value="public virtual bool MouseEvent (Terminal.Gui.MouseEvent mouseEvent);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool MouseEvent(valuetype Terminal.Gui.MouseEvent mouseEvent) cil managed" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -73,7 +73,7 @@
         <Parameter Name="me" Type="Terminal.Gui.MouseEvent" />
       </Parameters>
       <Docs>
-        <param name="me">Me.</param>
+        <param name="mouseEvent">Contains the details about the mouse event.</param>
         <summary>
             Method invoked when a mouse event is generated
             </summary>
@@ -83,8 +83,8 @@
       </Docs>
     </Member>
     <Member MemberName="ProcessColdKey">
-      <MemberSignature Language="C#" Value="public virtual bool ProcessColdKey (Terminal.Gui.KeyEvent kb);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ProcessColdKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
+      <MemberSignature Language="C#" Value="public virtual bool ProcessColdKey (Terminal.Gui.KeyEvent keyEvent);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ProcessColdKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -96,7 +96,7 @@
         <Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
       </Parameters>
       <Docs>
-        <param name="kb">To be added.</param>
+        <param name="keyEvent">Contains the details about the key that produced the event.</param>
         <summary>
               This method can be overwritten by views that
                 want to provide accelerator functionality
@@ -161,8 +161,8 @@
       </Docs>
     </Member>
     <Member MemberName="ProcessKey">
-      <MemberSignature Language="C#" Value="public virtual bool ProcessKey (Terminal.Gui.KeyEvent kb);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
+      <MemberSignature Language="C#" Value="public virtual bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -174,7 +174,7 @@
         <Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
       </Parameters>
       <Docs>
-        <param name="kb">To be added.</param>
+        <param name="keyEvent">Contains the details about the key that produced the event.</param>
         <summary>
               If the view is focused, gives the view a
               chance to process the keystroke. 

+ 3 - 3
ecmadocs/en/Terminal.Gui/Toplevel.xml

@@ -75,8 +75,8 @@
       </Docs>
     </Member>
     <Member MemberName="ProcessKey">
-      <MemberSignature Language="C#" Value="public override bool ProcessKey (Terminal.Gui.KeyEvent kb);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
+      <MemberSignature Language="C#" Value="public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -88,7 +88,7 @@
         <Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
       </Parameters>
       <Docs>
-        <param name="kb">To be added.</param>
+        <param name="keyEvent">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>

+ 9 - 9
ecmadocs/en/Terminal.Gui/View.xml

@@ -741,8 +741,8 @@
       </Docs>
     </Member>
     <Member MemberName="ProcessColdKey">
-      <MemberSignature Language="C#" Value="public override bool ProcessColdKey (Terminal.Gui.KeyEvent kb);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessColdKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
+      <MemberSignature Language="C#" Value="public override bool ProcessColdKey (Terminal.Gui.KeyEvent keyEvent);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessColdKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -754,15 +754,15 @@
         <Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
       </Parameters>
       <Docs>
-        <param name="kb">To be added.</param>
+        <param name="keyEvent">Contains the details about the key that produced the event.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
     <Member MemberName="ProcessHotKey">
-      <MemberSignature Language="C#" Value="public override bool ProcessHotKey (Terminal.Gui.KeyEvent kb);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessHotKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
+      <MemberSignature Language="C#" Value="public override bool ProcessHotKey (Terminal.Gui.KeyEvent keyEvent);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessHotKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -774,15 +774,15 @@
         <Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
       </Parameters>
       <Docs>
-        <param name="kb">To be added.</param>
+        <param name="keyEvent">Contains the details about the key that produced the event.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
     <Member MemberName="ProcessKey">
-      <MemberSignature Language="C#" Value="public override bool ProcessKey (Terminal.Gui.KeyEvent kb);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
+      <MemberSignature Language="C#" Value="public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent keyEvent) cil managed" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -794,7 +794,7 @@
         <Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
       </Parameters>
       <Docs>
-        <param name="kb">To be added.</param>
+        <param name="keyEvent">Contains the details about the key that produced the event.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>

+ 5 - 5
ecmadocs/en/Terminal.Gui/Window.xml

@@ -122,8 +122,8 @@
       </Docs>
     </Member>
     <Member MemberName="MouseEvent">
-      <MemberSignature Language="C#" Value="public override bool MouseEvent (Terminal.Gui.MouseEvent me);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool MouseEvent(valuetype Terminal.Gui.MouseEvent me) cil managed" />
+      <MemberSignature Language="C#" Value="public override bool MouseEvent (Terminal.Gui.MouseEvent mouseEvent);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool MouseEvent(valuetype Terminal.Gui.MouseEvent mouseEvent) cil managed" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -135,7 +135,7 @@
         <Parameter Name="me" Type="Terminal.Gui.MouseEvent" />
       </Parameters>
       <Docs>
-        <param name="me">To be added.</param>
+        <param name="mouseEvent">To be added.</param>
         <summary>To be added.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -161,8 +161,8 @@
       </Docs>
     </Member>
     <Member MemberName="Remove">
-      <MemberSignature Language="C#" Value="public virtual void Remove (Terminal.Gui.View view);" />
-      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Remove(class Terminal.Gui.View view) cil managed" />
+      <MemberSignature Language="C#" Value="public override void Remove (Terminal.Gui.View view);" />
+      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Remove(class Terminal.Gui.View view) cil managed" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>0.0.0.0</AssemblyVersion>

Some files were not shown because too many files changed in this diff