add some descriptions

mmaulwurff · Jul 12, 2020 · d16a378 · d16a378
1 parent adc3965
commit d16a378
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 14 deletions.
diff --git a/zscript.zs b/zscript.zs
@@ -1,13 +1,27 @@
 version "4.4.2"
 
+/**
+ * This file is an entry point for Autoautosave.
+ */
 #include "zscript/aas_main.zs"
 
+/**
+ * These files are the heart of Autoautosave. They define and generate events.
+ */
+#include "zscript/aas_event_source.zs"
 #include "zscript/aas_event.zs"
+#include "zscript/aas_save_timer.zs"
 #include "zscript/aas_token.zs"
-#include "zscript/aas_token_example.zs"
+#include "zscript/checkers/aas_active_enemies_checker.zs"
 
-#include "zscript/aas_event_source.zs"
+/**
+ * This file contains examples of Universal Autoautosave Tokens.
+ */
+#include "zscript/aas_universal_token_examples.zs"
 
+/**
+ * These classes handle events, each in its own way.
+ */
 #include "zscript/handlers/aas_event_handler.zs"
 #include "zscript/handlers/aas_event_handlers.zs"
 #include "zscript/handlers/aas_logger.zs"
@@ -16,25 +30,36 @@ version "4.4.2"
 #include "zscript/handlers/aas_screenshooter.zs"
 #include "zscript/handlers/aas_voice.zs"
 
+/**
+ * These classes count the enemies on the level.
+ */
+#include "zscript/counters/aas_enemies_counter.zs"
+#include "zscript/counters/aas_active_enemies_counter.zs"
+#include "zscript/counters/aas_active_bosses_counter.zs"
+
+/**
+ * These classes call engine's save and screenshoting functions.
+ */
 #include "zscript/aas_game_actions.zs"
 #include "zscript/aas_game_action_scheduler.zs"
 
-#include "zscript/aas_cvar.zs"
-
+/**
+ * These classes provide access to time.
+ */
 #include "zscript/clocks/aas_clock.zs"
 #include "zscript/clocks/aas_level_clock.zs"
 
+/**
+ * These classes are helper utilities.
+ */
 #include "zscript/aas_timestamp.zs"
-#include "zscript/aas_save_timer.zs"
-
 #include "zscript/aas_log.zs"
+#include "zscript/aas_cvar.zs"
+#include "zscript/aas_precache_sounds.zs"
 
-#include "zscript/checkers/aas_active_enemies_checker.zs"
-
-#include "zscript/counters/aas_enemies_counter.zs"
-#include "zscript/counters/aas_active_enemies_counter.zs"
-#include "zscript/counters/aas_active_bosses_counter.zs"
-
+/**
+ * Tests.
+ *
+ * Not much here, sadly.
+ */
 #include "zscript/tests/aas_active_enemies_checker_test.zs"
-
-#include "zscript/aas_precache_sounds.zs"
diff --git a/zscript/aas_token_example.zs → zscript/aas_universal_token_examples.zs b/zscript/aas_token_example.zs → zscript/aas_universal_token_examples.zs
diff --git a/zscript/counters/aas_active_bosses_counter.zs b/zscript/counters/aas_active_bosses_counter.zs
@@ -16,6 +16,9 @@
  * Autoautosave.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+/**
+ * This class implements aas_enemies_counter by counting active bosses.
+ */
 class aas_active_bosses_counter : aas_enemies_counter
 {
 

diff --git a/zscript/counters/aas_active_enemies_counter.zs b/zscript/counters/aas_active_enemies_counter.zs
@@ -16,6 +16,9 @@
  * Autoautosave.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+/**
+ * This class implements aas_enemies_counter by counting the active enemies.
+ */
 class aas_active_enemies_counter : aas_enemies_counter
 {
 

diff --git a/zscript/counters/aas_enemies_counter.zs b/zscript/counters/aas_enemies_counter.zs
@@ -16,6 +16,9 @@
  * Autoautosave.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+/**
+ * This is a generic interface for reporting how much enemies are on the level.
+ */
 class aas_enemies_counter abstract
 {