From 13ec2cc57b5bd490766563f1de8f711eafb029f3 Mon Sep 17 00:00:00 2001 From: Jason Felds Date: Tue, 1 Mar 2011 01:04:54 -0500 Subject: [PATCH] Minor doc work. --- src/AutoKeysounds.h | 1 + src/OptionsCursor.h | 4 ++++ src/ScreenMessage.h | 11 +++++------ src/ScreenPackagesSSC.h | 9 +++++---- 4 files changed, 15 insertions(+), 10 deletions(-) diff --git a/src/AutoKeysounds.h b/src/AutoKeysounds.h index ff51f24e2b..2e980b6cfb 100644 --- a/src/AutoKeysounds.h +++ b/src/AutoKeysounds.h @@ -14,6 +14,7 @@ class AutoKeysounds public: void Load( PlayerNumber pn, const NoteData& ndAutoKeysoundsOnly ); void Update( float fDelta ); + /** @brief Finish loading the main sounds, and setup the auto keysounds if any. */ void FinishLoading(); RageSound *GetSound() { return &m_sSound; } RageSoundReader *GetSharedSound() { return m_pSharedSound; } diff --git a/src/OptionsCursor.h b/src/OptionsCursor.h index a1b4da23f9..85f9a19ea3 100644 --- a/src/OptionsCursor.h +++ b/src/OptionsCursor.h @@ -9,7 +9,11 @@ class OptionsCursor : public ActorFrame { public: + /** @brief Set up a default OptionsCursor. */ OptionsCursor(); + /** + * @brief Set up an OptionsCursor based on an existing copy. + * @param cpy the OptionsCursor we are copying. */ OptionsCursor( const OptionsCursor &cpy ); void Load( const RString &sMetricsGroup, bool bLoadCanGos ); diff --git a/src/ScreenMessage.h b/src/ScreenMessage.h index 5124cd52a0..7fbc86924f 100644 --- a/src/ScreenMessage.h +++ b/src/ScreenMessage.h @@ -1,8 +1,6 @@ -/* ScreenMessage - Definition of common ScreenMessages and helpers. */ - #ifndef ScreenMessage_H #define ScreenMessage_H - +/** @brief Definition of common ScreenMessages and helpers. */ typedef RString ScreenMessage; extern const ScreenMessage SM_Invalid; @@ -28,11 +26,12 @@ namespace ScreenMessageHelpers #define AutoScreenMessage( x ) \ const ScreenMessage x = ScreenMessageHelpers::ToScreenMessage( #x ) - #endif -/* - * (c) 2003-2005 Chris Danford, Charles Lohr +/** + * @file + * @author Chris Danford, Charles Lohr (c) 2003-2005 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/ScreenPackagesSSC.h b/src/ScreenPackagesSSC.h index 7ae4f1d821..cf3c6d9509 100644 --- a/src/ScreenPackagesSSC.h +++ b/src/ScreenPackagesSSC.h @@ -1,4 +1,3 @@ -/* ScreenPackagesSSC - parses JSON for downloadable content. */ #ifndef SCREEN_PACKAGES_SSC_H #define SCREEN_PACKAGES_SSC_H @@ -8,7 +7,7 @@ #include "RageFileManager.h" #include "RageFile.h" #include "Sprite.h" - +/** @brief Parses JSON for downloadable content. */ class ScreenPackagesSSC : public ScreenWithMenuElements { public: @@ -28,8 +27,10 @@ private: #endif -/* - * (c) 2004 Chris Danford +/** + * @file + * @author Chris Danford (c) 2004 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a