Skip to content

Commit

Permalink
Update documentation for goto implementation feature
Browse files Browse the repository at this point in the history
  • Loading branch information
andreesteve committed Feb 25, 2018
1 parent 529a467 commit 06e89e9
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,15 @@ <h2 id="features">Features</h2>
<ul>
<li>Set default project for creation of <em>request</em> and <em>response</em> classes</li>
<li>Create <em>request</em> and <em>response</em> classes out of method definition, including documentation</li>
<li>Navigate to the <em>RequestHandler</em> that implements a <em>request</em> type</li>
</ul>
<h2 id="quick-start">Quick start</h2>
<h3 id="navigate-to-the-requesthandler-that-implements-a-request-type">Navigate to the RequestHandler that implements a Request type</h3>
<ol>
<li>Right click on a variable or type for a <em>Request</em> and then select <strong>Navigate to request handler's implementation</strong>. Alternatively, you can use the shortcut <strong>Ctrl+F12</strong> when the carret is over the variable or type.</li>
</ol>
<p><img src="docs/imgs/gotoimplementation.png" alt="Right click on the type and select Navigate to request handler's implementation" /></p>
<h3 id="generating-request-response-classes">Generating request-response classes</h3>
<ol>
<li>Set a default project in the solution where <em>request and reponse</em> classes are to be created in
by right clicking on the project in the solution explorer and selecting <strong>Commerce Runtime Handyman -&gt; Set as default Request-Response project</strong>*</li>
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,18 @@ You can install it:

* Set default project for creation of *request* and *response* classes
* Create *request* and *response* classes out of method definition, including documentation
* Navigate to the *RequestHandler* that implements a *request* type

## Quick start

### Navigate to the RequestHandler that implements a Request type

1. Right click on a variable or type for a *Request* and then select **Navigate to request handler's implementation**. Alternatively, you can use the shortcut **Ctrl+F12** when the carret is over the variable or type.

![Right click on the type and select Navigate to request handler's implementation](docs/imgs/gotoimplementation.png)

### Generating request-response classes

1. Set a default project in the solution where *request and reponse* classes are to be created in
by right clicking on the project in the solution explorer and selecting **Commerce Runtime Handyman -> Set as default Request-Response project***

Expand Down
Binary file added docs/imgs/gotoimplementation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 06e89e9

Please sign in to comment.