Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update C/C++ Documentation #6364

Merged
merged 1 commit into from
Oct 11, 2019
Merged

Update C/C++ Documentation #6364

merged 1 commit into from
Oct 11, 2019

Conversation

vince-fugnitto
Copy link
Member

What it does

Updated the documentation for the C/C++ extension in alignment
with one of the mandates to improve documentation before the 1.0.0
release milestone.

Note: the following tslint checks were added during testing, and documentation was updated to make the tests pass (errors.tslint.json)

"rules": {
    "completed-docs": [true, "enums", "enum-members", "functions", "interfaces", "methods"],
    "no-redundant-jsdoc": true,
}

How to test

Verify the documentation.

Review checklist

Reminder for reviewers

Signed-off-by: Vincent Fugnitto [email protected]

@vince-fugnitto vince-fugnitto added cpp issues related to the C/C++ language documentation issues related to documentation labels Oct 10, 2019
@vince-fugnitto vince-fugnitto self-assigned this Oct 10, 2019
Copy link
Contributor

@elaihau elaihau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me. Thank you Vincent !

- Updated the documentation for the C/C++ extension in alignment
with one of the mandates to improve documentation before the 1.0.0
release milestone.

Signed-off-by: Vincent Fugnitto <[email protected]>
@vince-fugnitto
Copy link
Member Author

looks good to me. Thank you Vincent !

Thank you @elaihau, fixing the trailing whitespace for CI.

@vince-fugnitto vince-fugnitto merged commit e4fb256 into master Oct 11, 2019
@vince-fugnitto vince-fugnitto deleted the vf/documentation-cpp branch October 11, 2019 12:55
@vince-fugnitto vince-fugnitto restored the vf/documentation-cpp branch October 11, 2019 12:56
@vince-fugnitto vince-fugnitto deleted the vf/documentation-cpp branch October 11, 2019 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cpp issues related to the C/C++ language documentation issues related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants