More docs.
Note: in DisplayResolutions, the @brief before the #define is not showing on the generated docs. This may need to be looked in to.
This commit is contained in:
@@ -2,16 +2,24 @@
|
||||
#define DisplayResolutions_H
|
||||
|
||||
#include <set>
|
||||
|
||||
/** @brief The dimensions of the program. */
|
||||
class DisplayResolution
|
||||
{
|
||||
public:
|
||||
/** @brief The width of the program. */
|
||||
int iWidth;
|
||||
/** @brief The height of the program. */
|
||||
int iHeight;
|
||||
/** @brief Is this display stretched/used for widescreen? */
|
||||
bool bStretched;
|
||||
|
||||
/**
|
||||
* @brief Determine if one DisplayResolution is less than the other.
|
||||
* @param other the other DisplayResolution to check.
|
||||
* @return true if this DisplayResolution is less than the other, or false otherwise. */
|
||||
bool operator<( const DisplayResolution &other ) const
|
||||
{
|
||||
/** @brief A quick way to compare the two DisplayResolutions. */
|
||||
#define COMPARE(x) if( x != other.x ) return x < other.x;
|
||||
COMPARE( iWidth );
|
||||
COMPARE( iHeight );
|
||||
@@ -20,13 +28,15 @@ public:
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
/** @brief The collection of DisplayResolutions available within the program. */
|
||||
typedef set<DisplayResolution> DisplayResolutions;
|
||||
|
||||
#endif
|
||||
|
||||
/*
|
||||
* (c) 2001-2005 Chris Danford
|
||||
/**
|
||||
* @file
|
||||
* @author Chris Danford (c) 2001-2005
|
||||
* @section LICENSE
|
||||
* All rights reserved.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a
|
||||
|
||||
Reference in New Issue
Block a user