From 552a80ecc853a6882452a68582ab2a6bfec9e524 Mon Sep 17 00:00:00 2001 From: Hans Kokx Date: Tue, 17 Mar 2026 11:20:04 +0100 Subject: [PATCH] Added some dartdocs Signed-off-by: Hans Kokx --- packages/wolf_3d_dart/lib/wolf_3d_entities.dart | 11 +++++++++-- packages/wolf_3d_dart/lib/wolf_3d_input.dart | 4 ++++ packages/wolf_3d_dart/lib/wolf_3d_synth.dart | 5 +++-- 3 files changed, 16 insertions(+), 4 deletions(-) diff --git a/packages/wolf_3d_dart/lib/wolf_3d_entities.dart b/packages/wolf_3d_dart/lib/wolf_3d_entities.dart index 685ed0f..abe86b2 100644 --- a/packages/wolf_3d_dart/lib/wolf_3d_entities.dart +++ b/packages/wolf_3d_dart/lib/wolf_3d_entities.dart @@ -1,6 +1,13 @@ -/// Support for doing something awesome. +/// Main entry point for all entity-related functionalities in the Wolf3D project. /// -/// More dartdocs go here. +/// This library exports various entity types, including: +/// - Enemies (e.g., [Guard], [Mutant], [HansGrosse]) +/// - Weapons (e.g., [Pistol], [MachineGun]) +/// - Collectibles (e.g., [Ammo]) +/// - Doors ([Door]) +/// - Decorative elements ([Decorative], [DeadGuard]) +/// +/// It also provides access to the [EntityRegistry] for managing entities. library; export 'src/entities/entities/collectible.dart'; diff --git a/packages/wolf_3d_dart/lib/wolf_3d_input.dart b/packages/wolf_3d_dart/lib/wolf_3d_input.dart index 2742dac..8ded6ea 100644 --- a/packages/wolf_3d_dart/lib/wolf_3d_input.dart +++ b/packages/wolf_3d_dart/lib/wolf_3d_input.dart @@ -1,3 +1,7 @@ +/// Entry point for the input handling module of Wolf3D. +/// +/// This library consolidates access to various input methods, exporting +/// functionalities from sub-modules like CLI input handling. library; export 'src/input/cli_input.dart'; diff --git a/packages/wolf_3d_dart/lib/wolf_3d_synth.dart b/packages/wolf_3d_dart/lib/wolf_3d_synth.dart index 9e96b77..bcffb04 100644 --- a/packages/wolf_3d_dart/lib/wolf_3d_synth.dart +++ b/packages/wolf_3d_dart/lib/wolf_3d_synth.dart @@ -1,6 +1,7 @@ -/// Support for doing something awesome. +/// Entry point for the sound synthesis module of Wolf3D. /// -/// More dartdocs go here. +/// This library provides access to audio functionalities, primarily by exporting +/// the [WolfAudio] class. library; export 'src/synth/wolf_3d_audio.dart' show WolfAudio;