Fix a couple of typos in Jsrt Header comments #5659
Conversation
lib/Jsrt/ChakraCommon.h
Outdated
| @@ -199,7 +199,7 @@ typedef unsigned short uint16_t; | |||
| /// </summary> | |||
| JsErrorInObjectBeforeCollectCallback, | |||
| /// <summary> | |||
| /// Object cannot be unwrapped to IInspectable pointer. | |||
| /// Object cannot be unwrapped to Inspectable pointer. | |||
There was a problem hiding this comment.
This might have been intentional - IInspectable by .NET convention would be Interface Inspectable
There was a problem hiding this comment.
.NET and, possibly more importantly, WinRT convention. I think this has to do with JSRT Projection
| @@ -237,6 +237,7 @@ typedef unsigned short uint16_t; | |||
| /// Module was not yet evaluated when JsGetModuleNamespace was called. | |||
| /// </summary> | |||
| JsErrorModuleNotEvaluated, | |||
|
|
|||
There was a problem hiding this comment.
The next line is the start of a category, all the other categories are preceded by a blank line.
There was a problem hiding this comment.
Looks fine, but needs a review from someone familiar with the conventions. /cc @liminzhu
We should propagate the changes to these comments over to the wiki -- you can send a PR to https://github.com/Microsoft/ChakraCore-wiki
|
Shouldn't the wiki be auto-generate-able from the header? Id imagine we already do that for the MSDN page. |
rhuanjl
force-pushed
the
updateHeaders
branch
from
2e62237 to
9f609be
Compare
lib/Jsrt/ChakraCommon.h
Outdated
| @@ -217,7 +217,7 @@ typedef unsigned short uint16_t; | |||
| /// </summary> | |||
| JsErrorInvalidContext, | |||
| /// <summary> | |||
| /// Module evaluation is called in wrong context. | |||
| /// Invalid Module HostInfoKind provided to JsSetModuleHostInfo or JsGetModuleHostInfo. | |||
There was a problem hiding this comment.
I'd avoid mentioning specific APIs for future-proofing and just say The Module HostInfoKind provided is invalid.
rhuanjl
force-pushed
the
updateHeaders
branch
from
9f609be to
63ca567
Compare
Merge pull request #5659 from rhuanjl:updateHeaders This PR fixes a few typos I noticed in the Jsrt Header comments as well as one pointed out by @RealTrisT in #5615
This PR fixes a few typos I noticed in the Jsrt Header comments as well as one pointed out by @RealTrisT in #5615