[WIP] Documenting anathema #55
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
togglebyte
force-pushed
the
dev
branch
3 times, most recently
from
1671736 to
4e431e5
Compare
togglebyte
approved these changes
Aug 31, 2024
anathema-backend/src/lib.rs
Outdated
| fn clear(&mut self); | ||
|
|
||
| /// Finalizes the backend. This is called just before we start running the anathema main loop. |
There was a problem hiding this comment.
Suggested change
| /// Finalizes the backend. This is called just before we start running the anathema main loop. | |
| /// Finalizes the backend. This is called when the runtime starts. |
anathema-backend/src/lib.rs
Outdated
| /// Finalizes the backend. This is called just before we start running the anathema main loop. | ||
| /// This should set the terminal in a state where its usable for the tui, for example by enabling events. | ||
| /// | ||
| /// There is no guarantee that other functions will be called before this. They should not cause a panic. |
There was a problem hiding this comment.
Suggested change
| /// There is no guarantee that other functions will be called before this. They should not cause a panic. |
anathema-backend/src/lib.rs
Outdated
| fn clear(&mut self); | ||
|
|
||
| /// Finalizes the backend. This is called just before we start running the anathema main loop. | ||
| /// This should set the terminal in a state where its usable for the tui, for example by enabling events. |
There was a problem hiding this comment.
Suggested change
| /// This should set the terminal in a state where its usable for the tui, for example by enabling events. |
anathema-backend/src/tui/mod.rs
Outdated
| @@ -38,25 +38,29 @@ pub struct TuiBackendBuilder { | |||
| } | |||
|
|
|||
| impl TuiBackendBuilder { | |||
| /// Enable alt screen | |||
| // Note: This will only apply when TuiBackend::finalize is called. | |||
There was a problem hiding this comment.
Suggested change
| // Note: This will only apply when TuiBackend::finalize is called. |
anathema-backend/src/tui/mod.rs
Outdated
Comment on lines
48
to
49
| // Note: This will only apply when TuiBackend::finalize is called. | ||
| /// Enable mouse support. This won't apply until Runtime::run is called. |
There was a problem hiding this comment.
Suggested change
| // Note: This will only apply when TuiBackend::finalize is called. | |
| /// Enable mouse support. This won't apply until Runtime::run is called. | |
| /// Enable mouse support. |
anathema-runtime/src/lib.rs
Outdated
| @@ -74,6 +77,10 @@ impl<T> RuntimeBuilder<T> { | |||
| Ok(id.into()) | |||
| } | |||
|
|
|||
| /// Registers a [Component] as a prototype to the [Runtime], which allows the usage of multiple instances of the component in the templates. | |||
There was a problem hiding this comment.
Suggested change
| /// Registers a [Component] as a prototype to the [Runtime], which allows the usage of multiple instances of the component in the templates. | |
| /// Registers a [Component] as a prototype with the [Runtime], which allows the usage of multiple instances of the component in the templates. |
anathema-runtime/src/lib.rs
Outdated
| @@ -74,6 +77,10 @@ impl<T> RuntimeBuilder<T> { | |||
| Ok(id.into()) | |||
| } | |||
|
|
|||
| /// Registers a [Component] as a prototype to the [Runtime], which allows the usage of multiple instances of the component in the templates. | |||
| /// This is useful if you want to reuse the component (Such as an input or button component) or if you use your component in if-blocks or for loops. | |||
There was a problem hiding this comment.
Suggested change
| /// This is useful if you want to reuse the component (Such as an input or button component) or if you use your component in if-blocks or for loops. | |
| /// This is useful for reuse of components. |
Co-authored-by: Togglebit <[email protected]>
Co-authored-by: Togglebit <[email protected]>
Co-authored-by: Togglebit <[email protected]>
Co-authored-by: Togglebit <[email protected]>
Co-authored-by: Togglebit <[email protected]>
togglebyte
approved these changes
Aug 31, 2024
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.
I've taken up the task of documenting most of anathema. Any critique is welcomed. Note: I use everywhere rustdoc-style comments (
///) except for internal api information on public api, as it is not very relevant. I use normal comments (//) for those.