Application documentation #142
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
The trait is transformed into structs with methods. It is useful to have some global information to go with the struct and its methods. It may seem redundant to repeat this header but as module level docs are separated from these structs in docs, I think it is warranted to find it in both places.
We have `Accessible` the trait, and former Accessible which is now named `ObjectRef`. Here we mean to refer to the object.
For `Application`, no longer rely on external link. `ObjectRef` replaces former `Accessible` link.
`get_children` docs had external link, is now internal.
Improve / replace module-level docs of `atspi-proxies::application` Note that these docs are repeated on the `Application` trait, because it gets converted into `ApplicationProxy` (and its blocking sibling). These documentation pages are separate from the module-level, but it is useful to have some overview at the struct level too.
The trait `Applicattion` is converted into: `ApplicationProxy` and `BlockingApplicationProxy`, which benefit from some global / overview docs. In the source it looks a bit overzealous but in the docs the module-level and the struct-level docs are separate.
The `version` method refers to the toolkit version.
Codecov Report
@@ Coverage Diff @@
## main #142 +/- ##
==========================================
- Coverage 90.00% 89.97% -0.04%
==========================================
Files 39 39
Lines 3172 3172
==========================================
- Hits 2855 2854 -1
- Misses 317 318 +1
... and 1 file with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Thank you Luuk, and Federico! |
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.
This documents the
Applicationinterface.The XML level docs served as guideline.
Shoutout to @federico.