From 599e5791c54fb11fd872d684572c7d78be4f3089 Mon Sep 17 00:00:00 2001 From: Rob Wise Date: Tue, 26 Jan 2016 21:21:43 -0500 Subject: [PATCH] Fix jsdoc --- ...rails_view_rendering_from_inline_javascript.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/additional_reading/rails_view_rendering_from_inline_javascript.md b/docs/additional_reading/rails_view_rendering_from_inline_javascript.md index 4810d5685..e16bba528 100644 --- a/docs/additional_reading/rails_view_rendering_from_inline_javascript.md +++ b/docs/additional_reading/rails_view_rendering_from_inline_javascript.md @@ -2,9 +2,18 @@ You can easily render React components in your JavaScript with `render` method that returns a [reference to the component](https://facebook.github.io/react/docs/more-about-refs.html) (virtual DOM element). ```js -// componentName - name of your registered component; -// props - Object which contains the properties to pass to the react object; -// elementId - id of an element where we render our React component; +/** + * ReactOnRails.render("HelloWorldApp", {name: "Stranger"}, 'app'); + * + * Does this: + * ReactDOM.render(React.createElement(HelloWorldApp, {name: "Stranger"}), + * document.getElementById('app')) + * + * @param name Name of your registered component + * @param props Props to pass to your component + * @param domNodeId + * @returns {virtualDomElement} Reference to your component's backing instance + */ ReactOnRails.render(componentName, props, elementId) ```