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.

Sign up for GitHub

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

Jump to bottom

[DOC] Added doxygen comments from spec #1305

Merged
merged 4 commits into from
Dec 8, 2020
Merged

[DOC] Added doxygen comments from spec #1305

merged 4 commits into from
Dec 8, 2020

Conversation

outoftardis
Copy link
Contributor

@outoftardis outoftardis commented Dec 1, 2020 •
edited
Loading

Description

From #1074: the part with doxygen comments

  • transferred doxygen comments from specs, made small changes in wording (e.g. removed "shall")

RST files will be added separately. The tool is in #1303 and will also be merged separately.

@outoftardis outoftardis added docs Issue/PR related to oneDAL docs backport-2021 Mergify label for ports to 2021-gold labels Dec 1, 2020
@outoftardis
Copy link
Contributor Author

/intelci: run

@outoftardis
Copy link
Contributor Author

/intelci: run

@outoftardis
Copy link
Contributor Author

/intelci: run

@outoftardis
Copy link
Contributor Author

@rlnx @michael-smirnov @mchernov-intel any comments? can we merge this?

mchernov-intel
mchernov-intel approved these changes Dec 3, 2020
View reviewed changes
Copy link
Contributor

@mchernov-intel mchernov-intel left a comment

Choose a reason for hiding this comment

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

Please, wait for another approve

@outoftardis
Copy link
Contributor Author

@rlnx @michael-smirnov any comments from your side?

rlnx
rlnx reviewed Dec 8, 2020
View reviewed changes
Copy link
Contributor

@rlnx rlnx left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Sometimes $...$ is used for template or runtime parameters, please replace with :literal:....

$...$ should be used only for math expressions.

I've highlighted few cases, but it could be more

cpp/oneapi/dal/array.hpp Outdated Show resolved Hide resolved
cpp/oneapi/dal/array.hpp Outdated Show resolved Hide resolved
cpp/oneapi/dal/array.hpp Outdated Show resolved Hide resolved
@outoftardis outoftardis merged commit c4363f5 into uxlfoundation:master Dec 8, 2020
mergify bot pushed a commit that referenced this pull request Dec 8, 2020
@outoftardis
[DOC] Added doxygen comments from spec (#1305)
b5bfbdc 
* Added doxygen comments from spec

* Removed tail spaces

* Fixed clang

(cherry picked from commit c4363f5)
@mergify mergify bot mentioned this pull request Dec 8, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rlnx rlnx rlnx approved these changes

@mchernov-intel mchernov-intel mchernov-intel approved these changes

@michael-smirnov michael-smirnov Awaiting requested review from michael-smirnov

Assignees
No one assigned
Labels
backport-2021 Mergify label for ports to 2021-gold docs Issue/PR related to oneDAL docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@outoftardis @rlnx @mchernov-intel