From 84c1ee87f827a85c7accd92e061077ef291cb433 Mon Sep 17 00:00:00 2001
From: Luan Nico <luanpotter27@gmail.com>
Date: Thu, 6 Jun 2024 06:53:22 -0700
Subject: [PATCH] docs: Add dartdocs to inline text node classes (#3189)

Add dartdocs to inline text node classes.
---
 packages/flame/lib/src/text/nodes/bold_text_node.dart   | 1 +
 packages/flame/lib/src/text/nodes/code_text_node.dart   | 1 +
 packages/flame/lib/src/text/nodes/group_text_node.dart  | 1 +
 packages/flame/lib/src/text/nodes/inline_text_node.dart | 1 +
 packages/flame/lib/src/text/nodes/italic_text_node.dart | 1 +
 packages/flame/lib/src/text/nodes/plain_text_node.dart  | 1 +
 6 files changed, 6 insertions(+)

diff --git a/packages/flame/lib/src/text/nodes/bold_text_node.dart b/packages/flame/lib/src/text/nodes/bold_text_node.dart
index e447ab6b216..f452dfd0c41 100644
--- a/packages/flame/lib/src/text/nodes/bold_text_node.dart
+++ b/packages/flame/lib/src/text/nodes/bold_text_node.dart
@@ -3,6 +3,7 @@ import 'dart:ui';
 import 'package:flame/src/text/nodes/inline_text_node.dart';
 import 'package:flame/text.dart';
 
+/// An [InlineTextNode] representing bold text.
 class BoldTextNode extends InlineTextNode {
   BoldTextNode(this.child);
 
diff --git a/packages/flame/lib/src/text/nodes/code_text_node.dart b/packages/flame/lib/src/text/nodes/code_text_node.dart
index 6e53c5e1514..43ca1c75edd 100644
--- a/packages/flame/lib/src/text/nodes/code_text_node.dart
+++ b/packages/flame/lib/src/text/nodes/code_text_node.dart
@@ -1,6 +1,7 @@
 import 'package:flame/src/text/nodes/inline_text_node.dart';
 import 'package:flame/text.dart';
 
+/// An [InlineTextNode] representing an inline code block string.
 class CodeTextNode extends InlineTextNode {
   CodeTextNode(this.child);
 
diff --git a/packages/flame/lib/src/text/nodes/group_text_node.dart b/packages/flame/lib/src/text/nodes/group_text_node.dart
index a40d8c08e3f..34fecc298b1 100644
--- a/packages/flame/lib/src/text/nodes/group_text_node.dart
+++ b/packages/flame/lib/src/text/nodes/group_text_node.dart
@@ -2,6 +2,7 @@ import 'package:flame/src/text/elements/group_text_element.dart';
 import 'package:flame/src/text/nodes/inline_text_node.dart';
 import 'package:flame/text.dart';
 
+/// An [InlineTextNode] to group other [InlineTextNode]s.
 class GroupTextNode extends InlineTextNode {
   GroupTextNode(this.children);
 
diff --git a/packages/flame/lib/src/text/nodes/inline_text_node.dart b/packages/flame/lib/src/text/nodes/inline_text_node.dart
index ca89ff2e226..c6aa4fe7642 100644
--- a/packages/flame/lib/src/text/nodes/inline_text_node.dart
+++ b/packages/flame/lib/src/text/nodes/inline_text_node.dart
@@ -7,6 +7,7 @@ import 'package:flame/text.dart';
 /// * PlainTextNode - just a string of plain text, no special formatting.
 /// * BoldTextNode - bolded string
 /// * ItalicTextNode - italic string
+/// * CodeTextNode - inline code block
 /// * GroupTextNode - collection of multiple [InlineTextNode]'s to be joined one
 ///                   after the other.
 abstract class InlineTextNode extends TextNode<InlineTextStyle> {
diff --git a/packages/flame/lib/src/text/nodes/italic_text_node.dart b/packages/flame/lib/src/text/nodes/italic_text_node.dart
index aed27dad848..4837b7023e1 100644
--- a/packages/flame/lib/src/text/nodes/italic_text_node.dart
+++ b/packages/flame/lib/src/text/nodes/italic_text_node.dart
@@ -3,6 +3,7 @@ import 'dart:ui';
 import 'package:flame/src/text/nodes/inline_text_node.dart';
 import 'package:flame/text.dart';
 
+/// An [InlineTextNode] representing italic text.
 class ItalicTextNode extends InlineTextNode {
   ItalicTextNode(this.child);
 
diff --git a/packages/flame/lib/src/text/nodes/plain_text_node.dart b/packages/flame/lib/src/text/nodes/plain_text_node.dart
index 4c04d4992cc..a02fcaeee7f 100644
--- a/packages/flame/lib/src/text/nodes/plain_text_node.dart
+++ b/packages/flame/lib/src/text/nodes/plain_text_node.dart
@@ -1,6 +1,7 @@
 import 'package:flame/src/text/nodes/inline_text_node.dart';
 import 'package:flame/text.dart';
 
+/// An [InlineTextNode] representing plain text.
 class PlainTextNode extends InlineTextNode {
   PlainTextNode(this.text);