docs: improved Anchor doc comment

4 years ago · a499885daf
parent 5b984b2754
commit a499885daf
1 changed files with 2 additions and 1 deletions
--- a/lib/game/components/anchor.dart
+++ b/lib/game/components/anchor.dart
@ -1,7 +1,8 @@
 import 'package:flame_forge2d/flame_forge2d.dart';

 /// {@template anchor}
-/// Non visual [BodyComponent] used to hold a [BodyType.dynamic] in [Joint]s.
+/// Non visual [BodyComponent] used to hold a [BodyType.dynamic] in [Joint]s 
+/// with this [BodyType.static].
 ///
 /// It is recommended to [_position] the anchor first and then use the body
 /// position as the anchor point when initializing a [JointDef].