fork/Graphite
1
0
Fork 0
mirror of https://github.com/GraphiteEditor/Graphite.git synced 2026-09-18 18:38:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation (#287)

Browse Source 
* Add crate documentation

* Use full path intead of relative path

* Add documentation to core/document/src/color.rs

* Add modification by

* Add @Keavon's modification

* @Keavon's changes

* remove useless let

Co-authored-by: TrueDoctor <dennis@kobert.dev>
This commit is contained in:
RustyNixieTube
2021-07-23 16:16:26 +02:00
committed by Keavon Chambers
parent 97f97480a2
commit 1da0678dbb
5 changed files with 133 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
core/editor/src/lib.rs
View File

@@ -1,3 +1,9 @@
//! **Graphite Editor Core Library**: `/core/editor/`
//! Used by a frontend editor client to maintain GUI state and dispatch user events.
//! The official Graphite editor is the primary user,
//! but others software like game engines could embed their own customized editor implementations.
//! Depends on the Document Core Library.
// since our policy is tabs, we want to stop clippy from warning about that
#![allow(clippy::tabs_in_doc_comments)]
@@ -50,24 +56,24 @@ impl Editor {
}
pub mod message_prelude {
pub use super::communication::message::{AsMessage, Message, MessageDiscriminant};
pub use super::communication::{ActionList, MessageHandler};
pub use super::document::{DocumentMessage, DocumentMessageDiscriminant};
pub use super::frontend::{FrontendMessage, FrontendMessageDiscriminant};
pub use super::global::{GlobalMessage, GlobalMessageDiscriminant};
pub use super::input::{InputMapperMessage, InputMapperMessageDiscriminant, InputPreprocessorMessage, InputPreprocessorMessageDiscriminant};
pub use super::misc::derivable_custom_traits::{ToDiscriminant, TransitiveChild};
pub use super::tool::tool_messages::*;
pub use super::tool::tools::crop::{CropMessage, CropMessageDiscriminant};
pub use super::tool::tools::eyedropper::{EyedropperMessage, EyedropperMessageDiscriminant};
pub use super::tool::tools::fill::{FillMessage, FillMessageDiscriminant};
pub use super::tool::tools::line::{LineMessage, LineMessageDiscriminant};
pub use super::tool::tools::navigate::{NavigateMessage, NavigateMessageDiscriminant};
pub use super::tool::tools::path::{PathMessage, PathMessageDiscriminant};
pub use super::tool::tools::pen::{PenMessage, PenMessageDiscriminant};
pub use super::tool::tools::rectangle::{RectangleMessage, RectangleMessageDiscriminant};
pub use super::tool::tools::select::{SelectMessage, SelectMessageDiscriminant};
pub use super::tool::tools::shape::{ShapeMessage, ShapeMessageDiscriminant};
pub use crate::communication::message::{AsMessage, Message, MessageDiscriminant};
pub use crate::communication::{ActionList, MessageHandler};
pub use crate::document::{DocumentMessage, DocumentMessageDiscriminant};
pub use crate::frontend::{FrontendMessage, FrontendMessageDiscriminant};
pub use crate::global::{GlobalMessage, GlobalMessageDiscriminant};
pub use crate::input::{InputMapperMessage, InputMapperMessageDiscriminant, InputPreprocessorMessage, InputPreprocessorMessageDiscriminant};
pub use crate::misc::derivable_custom_traits::{ToDiscriminant, TransitiveChild};
pub use crate::tool::tool_messages::*;
pub use crate::tool::tools::crop::{CropMessage, CropMessageDiscriminant};
pub use crate::tool::tools::eyedropper::{EyedropperMessage, EyedropperMessageDiscriminant};
pub use crate::tool::tools::fill::{FillMessage, FillMessageDiscriminant};
pub use crate::tool::tools::line::{LineMessage, LineMessageDiscriminant};
pub use crate::tool::tools::navigate::{NavigateMessage, NavigateMessageDiscriminant};
pub use crate::tool::tools::path::{PathMessage, PathMessageDiscriminant};
pub use crate::tool::tools::pen::{PenMessage, PenMessageDiscriminant};
pub use crate::tool::tools::rectangle::{RectangleMessage, RectangleMessageDiscriminant};
pub use crate::tool::tools::select::{SelectMessage, SelectMessageDiscriminant};
pub use crate::tool::tools::shape::{ShapeMessage, ShapeMessageDiscriminant};
pub use crate::LayerId;
pub use graphite_proc_macros::*;
pub use std::collections::VecDeque;