comment, cleanup

2005-02-13 03:40:37 +00:00
parent 5531efed09
commit 2412c73b22
15 changed files with 24 additions and 10 deletions
@@ -1,4 +1,4 @@
-/* NoteField - renders a NoteData */
+/* NoteField - An Actor that renders a NoteData. */

 #ifndef NOTE_FIELD_H
 #define NOTE_FIELD_H
@@ -1,5 +1,7 @@
-#ifndef NoteSkinMANAGER_H
-#define NoteSkinMANAGER_H
+/* NoteSkinManager - Loads note skins. */
+
+#ifndef NOTE_SKIN_MANAGER_H
+#define NOTE_SKIN_MANAGER_H

 #include "Command.h"
 #include "RageTypes.h"
@@ -1,3 +1,5 @@
+/* NoteTypes - Types for holding tap notes and scores. */
+
 #ifndef NOTE_TYPES_H
 #define NOTE_TYPES_H

@@ -1,3 +1,5 @@
+/* NotesLoader - Base class for step file loaders. */
+
 #ifndef NOTES_LOADER_H
 #define NOTES_LOADER_H

@@ -1,3 +1,5 @@
+/* KSFLoader - reads a Song from a set of .BMS files. */
+
 #ifndef NOTES_LOADER_BMS_H
 #define NOTES_LOADER_BMS_H

@@ -1,4 +1,4 @@
-/* KSFLoader - reads a Song from a .KSF file. */
+/* KSFLoader - Reads a Song from a set of .KSF files. */

 #ifndef NOTES_LOADER_KSF_H
 #define NOTES_LOADER_KSF_H
@@ -1,4 +1,4 @@
-/* NotesWriterDWI - writes a Song to a .DWI file. */
+/* NotesWriterDWI - Writes a Song to a .DWI file. */

 #ifndef NOTES_WRITER_DWI_H
 #define NOTES_WRITER_DWI_H
@@ -1,4 +1,4 @@
-/* NotesWriterSM - writes a Song to an .SM file. */
+/* NotesWriterSM - Writes a Song to an .SM file. */

 #ifndef NOTES_WRITER_SM_H
 #define NOTES_WRITER_SM_H
@@ -1,4 +1,4 @@
-/* OptionsCursor - cursor for ScreenOptions. */
+/* OptionsCursor - A cursor for ScreenOptions. */

 #ifndef OPTIONS_CURSOR_H
 #define OPTIONS_CURSOR_H
@@ -1,3 +1,5 @@
+/* PaneDisplay - An Actor that displays song information. */
+
 #ifndef PANE_DISPLAY_H
 #define PANE_DISPLAY_H

@@ -1,3 +1,5 @@
+/* PercentageDisplay - An Actor that displays a percentage. */
+
 #ifndef PERCENTAGE_DISPLAY_H
 #define PERCENTAGE_DISPLAY_H

@@ -1,3 +1,5 @@
+/* PlayerAI - Chooses which notes the AI steps on. */
+
 #ifndef PlayerAI_H
 #define PlayerAI_H

@@ -1,4 +1,4 @@
-/* PlayerNumber */
+/* PlayerNumber - A simple type representing a player. */

 #ifndef PlayerNumber_H
 #define PlayerNumber_H
@@ -1,4 +1,4 @@
-/* PlayerNumber */
+/* PlayerState - Holds per-player game state. */

 #ifndef PlayerState_H
 #define PlayerState_H
@@ -1,4 +1,4 @@
-/* ProfileManager -  Interface to profiles that exist on the machine or a memory card. */
+/* ProfileManager - Interface to machine and memory card profiles. */

 #ifndef ProfileManager_H
 #define ProfileManager_H