Skip to content

Commit 3bb4c8a

Browse files
fallahnfallahn
committed
add doxy file to generate documentation
1 parent b6a900f commit 3bb4c8a

8 files changed

Lines changed: 2483 additions & 7 deletions

File tree

‎tmxlite/documentation/Doxyfile‎

Lines changed: 2458 additions & 0 deletions
Large diffs are not rendered by default.

‎tmxlite/include/tmxlite/Layer.hpp‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ namespace pugi
4141
class xml_node;
4242
}
4343

44-
4544
namespace tmx
4645
{
4746
class Map;

‎tmxlite/include/tmxlite/Log.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ source distribution.
4646
namespace tmx
4747
{
4848
/*!
49-
\brief Class to allowing messages to be logged to a combination
49+
\brief Class allowing messages to be logged to a combination
5050
of one or more destinations such as the console, log file or
5151
output window in Visual Studio
5252
*/

‎tmxlite/include/tmxlite/Map.hpp‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ source distribution.
3939

4040
namespace tmx
4141
{
42+
/*!
43+
\brief Holds the xml version of the loaded map
44+
*/
4245
struct TMXLITE_EXPORT_API Version
4346
{
4447
//major/minor are apparently reserved by gcc
@@ -81,8 +84,8 @@ namespace tmx
8184
This class can be used to parse the XML format tile maps created
8285
with the Tiled map editor, providing an interface to create drawable and
8386
physics objects. Typical usage would be to create an instance of this
84-
class before calling load() providing a path to the *.tmx file to
85-
load. Then layers or objects can be requested from the Map class
87+
class before calling load() providing a path to the *.tmx file to be
88+
loaded. Then layers or objects can be requested from the Map class
8689
to be interpreted as needed.
8790
*/
8891
class TMXLITE_EXPORT_API Map final
@@ -128,7 +131,7 @@ namespace tmx
128131
*/
129132
const Vector2u& getTileSize() const { return m_tileSize; }
130133
/*!
131-
\brief Returns the bounds of the map in SFML units
134+
\brief Returns the bounds of the map
132135
*/
133136
FloatRect getBounds() const { return FloatRect(0.f, 0.f, static_cast<float>(m_tileCount.x * m_tileSize.x), static_cast<float>(m_tileCount.y * m_tileSize.y)); }
134137
/*!

‎tmxlite/include/tmxlite/Object.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ namespace tmx
108108
*/
109109
bool visible() const { return m_visible; }
110110
/*!
111-
\brief Returns the Shape of the Object
111+
\brief Returns the Shape type of the Object
112112
*/
113113
Shape getShape() const { return m_shape; }
114114
/*!

‎tmxlite/include/tmxlite/Property.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ namespace tmx
4242
{
4343
/*!
4444
\brief Represents a custom property.
45-
Tiles, objects and layers of a tmx may all have custom
45+
Tiles, objects and layers of a tmx map may have custom
4646
properties assigned to them. This class represents a
4747
single property and provides access to its value, the
4848
type of which can be determined with getType()

‎tmxlite/include/tmxlite/Tileset.hpp‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,14 @@ namespace tmx
6565
std::array<std::int32_t, 4u> terrainIndices;
6666
std::uint32_t probability = 100;
6767

68+
/*!
69+
\brief a group of frames which make up an animation
70+
*/
6871
struct Animation final
6972
{
73+
/*!
74+
\brief A frame within an animation
75+
*/
7076
struct Frame final
7177
{
7278
std::uint32_t tileID = 0;

‎tmxlite/include/tmxlite/Types.hpp‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ source distribution.
3232

3333
namespace tmx
3434
{
35+
/*!
36+
\brief Two dimensional vector used to store points and positions
37+
*/
3538
template <class T>
3639
struct Vector2 final
3740
{
@@ -44,6 +47,9 @@ namespace tmx
4447
using Vector2i = Vector2<int>;
4548
using Vector2u = Vector2<unsigned>;
4649

50+
/*!
51+
\brief Describes a rectangular area, such as an AABB (axis aligned bounding box)
52+
*/
4753
template <class T>
4854
struct Rectangle final
4955
{
@@ -56,6 +62,10 @@ namespace tmx
5662
using FloatRect = Rectangle<float>;
5763
using IntRect = Rectangle<int>;
5864

65+
/*!
66+
\brief Contains the red, green, blue and alpha values of a colour
67+
in the range 0 - 255.
68+
*/
5969
struct Colour final
6070
{
6171
Colour(std::uint8_t red = 0, std::uint8_t green = 0, std::uint8_t blue = 0, std::uint8_t alpha = 255)

0 commit comments

Comments
 (0)