docs: Add dartdocs to inline text node classes (#3189)

Add dartdocs to inline text node classes.
flame-engine · Jun 6, 2024 · 84c1ee8 · 84c1ee8
1 parent d0dc059
commit 84c1ee8
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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);