Document exceptionHandler arguments

reactjs · Dec 19, 2017 · a6ceeab · a6ceeab
1 parent 46b45b3
commit a6ceeab
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/src/React.Core/IReactComponent.cs b/src/React.Core/IReactComponent.cs
@@ -5,12 +5,12 @@
  *  This source code is licensed under the BSD-style license found in the
  *  LICENSE file in the root directory of this source tree. An additional grant
  *  of patent rights can be found in the PATENTS file in the same directory.
- */
-
+ */
+
 using System;
 
 namespace React
-{
+{
 	/// <summary>
 	/// Represents a React JavaScript component.
 	/// </summary>
@@ -46,8 +46,8 @@ public interface IReactComponent
 		/// return the rendered HTML.
 		/// </summary>
 		/// <param name="renderContainerOnly">Only renders component container. Used for client-side only rendering.</param>
-		/// <param name="renderServerOnly">Only renders the common HTML mark up and not any React specific data attributes. Used for server-side only rendering.</param>
-		/// <param name="exceptionHandler"></param>
+		/// <param name="renderServerOnly">Only renders the common HTML mark up and not any React specific data attributes. Used for server-side only rendering.</param>
+		/// <param name="exceptionHandler">A custom exception handler that will be called if a component throws during a render. Args: (Exception ex, string componentName, string containerId)</param>
 		/// <returns>HTML</returns>
 		string RenderHtml(bool renderContainerOnly = false, bool renderServerOnly = false, Action<Exception, string, string> exceptionHandler = null);
 

diff --git a/src/React.Core/ReactComponent.cs b/src/React.Core/ReactComponent.cs
@@ -5,8 +5,8 @@
  *  This source code is licensed under the BSD-style license found in the
  *  LICENSE file in the root directory of this source tree. An additional grant
  *  of patent rights can be found in the PATENTS file in the same directory.
- */
-
+ */
+
 using System;
 using System.Linq;
 using System.Text.RegularExpressions;
@@ -15,7 +15,7 @@
 using React.Exceptions;
 
 namespace React
-{
+{
 	/// <summary>
 	/// Represents a React JavaScript component.
 	/// </summary>
@@ -106,8 +106,8 @@ public ReactComponent(IReactEnvironment environment, IReactSiteConfiguration con
 		/// return the rendered HTML.
 		/// </summary>
 		/// <param name="renderContainerOnly">Only renders component container. Used for client-side only rendering.</param>
-		/// <param name="renderServerOnly">Only renders the common HTML mark up and not any React specific data attributes. Used for server-side only rendering.</param>
-		/// <param name="exceptionHandler"></param>
+		/// <param name="renderServerOnly">Only renders the common HTML mark up and not any React specific data attributes. Used for server-side only rendering.</param>
+		/// <param name="exceptionHandler">A custom exception handler that will be called if a component throws during a render. Args: (Exception ex, string componentName, string containerId)</param>
 		/// <returns>HTML</returns>
 		public virtual string RenderHtml(bool renderContainerOnly = false, bool renderServerOnly = false, Action<Exception, string, string> exceptionHandler = null)
 		{