Skip to content

Commit 35f7cfa

Browse files
TrueDoctoradamgerhantKeavon
authored
Parse description from node doc comments (#2089)
* Parse description from node doc comments * Add node description tooltips * Code review --------- Co-authored-by: Adam G <[email protected]> Co-authored-by: Keavon Chambers <[email protected]>
1 parent 8fdecaa commit 35f7cfa

File tree

12 files changed

+144
-24
lines changed

12 files changed

+144
-24
lines changed

editor/src/dispatcher.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
use crate::messages::debug::utility_types::MessageLoggingVerbosity;
22
use crate::messages::dialog::DialogMessageData;
3+
use crate::messages::portfolio::document::node_graph::document_node_definitions;
34
use crate::messages::prelude::*;
45

56
use graphene_core::text::Font;
@@ -137,6 +138,13 @@ impl Dispatcher {
137138
// Load the default font
138139
let font = Font::new(graphene_core::consts::DEFAULT_FONT_FAMILY.into(), graphene_core::consts::DEFAULT_FONT_STYLE.into());
139140
queue.add(FrontendMessage::TriggerFontLoad { font, is_default: true });
141+
142+
// Send the information for tooltips and categories for each node/input.
143+
queue.add(FrontendMessage::SendUIMetadata {
144+
input_type_descriptions: Vec::new(),
145+
node_descriptions: document_node_definitions::collect_node_descriptions(),
146+
node_types: document_node_definitions::collect_node_types(),
147+
});
140148
}
141149
Message::Batched(messages) => {
142150
messages.iter().for_each(|message| self.handle_message(message.to_owned()));

editor/src/messages/frontend/frontend_message.rs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,16 @@ pub enum FrontendMessage {
3939
},
4040
DisplayRemoveEditableTextbox,
4141

42+
// Send prefix: Send global, static data to the frontend that is never updated
43+
SendUIMetadata {
44+
#[serde(rename = "inputTypeDescriptions")]
45+
input_type_descriptions: Vec<(String, String)>,
46+
#[serde(rename = "nodeDescriptions")]
47+
node_descriptions: Vec<(String, String)>,
48+
#[serde(rename = "nodeTypes")]
49+
node_types: Vec<FrontendNodeType>,
50+
},
51+
4252
// Trigger prefix: cause a browser API to do something
4353
TriggerAboutGraphiteLocalizedCommitDate {
4454
#[serde(rename = "commitDate")]
@@ -245,10 +255,6 @@ pub enum FrontendMessage {
245255
id: NodeId,
246256
value: String,
247257
},
248-
UpdateNodeTypes {
249-
#[serde(rename = "nodeTypes")]
250-
node_types: Vec<FrontendNodeType>,
251-
},
252258
UpdateOpenDocumentsList {
253259
#[serde(rename = "openDocuments")]
254260
open_documents: Vec<FrontendDocumentDetails>,

0 commit comments

Comments
 (0)