672 Add documentation #692
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## develop #692 +/- ##
========================================
Coverage 80.66% 80.67%
========================================
Files 355 355
Lines 11184 11184
========================================
+ Hits 9022 9023 +1
+ Misses 2162 2161 -1
|
pnstickne
reviewed
Feb 14, 2020
pnstickne
reviewed
Feb 14, 2020
pnstickne
reviewed
Feb 14, 2020
pnstickne
reviewed
Feb 14, 2020
lifflander
force-pushed
the
672-documentation
branch
from
771b909 to
94977d3
Compare
|
Who is the target audience for this documentation? |
End users of the VT api. For immediate purposes, the auditors. Also, people we bring on board who want to learn VT. |
lifflander
force-pushed
the
672-documentation
branch
from
7bed070 to
f516d7b
Compare
lifflander
force-pushed
the
672-documentation
branch
from
deebc0a to
e2664e7
Compare
|
@PhilMiller Please have a look. I think I've made all the necessary changes or created issues for problems I don't want to tackle in this PR. |
|
Revisiting it all now |
PhilMiller
reviewed
Jun 22, 2020
PhilMiller
reviewed
Jun 22, 2020
PhilMiller
reviewed
Jun 22, 2020
| @@ -207,7 +209,7 @@ struct Scheduler : runtime::component::Component<Scheduler> { | |||
| void printMemoryUsage(); | |||
|
|
|||
| /** | |||
| * \brief Enqueue a action associated with a prioritized message. The action | |||
| * \brief Enqueue an action associated with a prioritized message. The action | |||
| * will be enqueued with the priority found on the message. | |||
| * | |||
| * \param[in] msg the message | |||
There was a problem hiding this comment.
I just realized that these enqueue overloads taking message arguments are kinda quirky wrappers to do
enqueue(getPriority(msg), action). I find only a single non-test call site, in messaging/active.cc
PhilMiller
reviewed
Jun 22, 2020
PhilMiller
reviewed
Jun 22, 2020
|
Issues
======
+ Solved 22
See the complete overview on Codacy |
PhilMiller
approved these changes
Jun 22, 2020
pnstickne
added a commit
that referenced
this pull request
Aug 11, 2020
- sendMsg accepting MsgT*& now reassigns the pointer to null.
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #672
Finally done... Docs for all components in VT. All the meta-docs pages for DARMA website.
You won't be able to see all the nice generated documentation until this gets merged. The auto-build will generate the docs publicly once that happens. Here's screenshot of what the home page looks like:
When it's merged, it will end up here: https://darma-tasking.github.io/docs/html/index.html
Introduction to VT:
The tutorial: