Skip to content

Commit fe8d8a9

Browse files
committed
Fix typos in public documentation
Typos found with codespell tool
1 parent 55fe064 commit fe8d8a9

File tree

11 files changed

+19
-19
lines changed

11 files changed

+19
-19
lines changed

include/CSFML/Graphics/RenderWindow.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ CSFML_GRAPHICS_API bool sfRenderWindow_pollEvent(sfRenderWindow* renderWindow, s
124124
/// \param renderWindow Render window object
125125
/// \param event Event to fill
126126
///
127-
/// \return false if an error occured
127+
/// \return false if an error occurred
128128
///
129129
////////////////////////////////////////////////////////////
130130
CSFML_GRAPHICS_API bool sfRenderWindow_waitEvent(sfRenderWindow* renderWindow, sfEvent* event);

include/CSFML/Graphics/Shape.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ CSFML_GRAPHICS_API sfFloatRect sfShape_getGlobalBounds(const sfShape* shape);
402402
/// \brief Recompute the internal geometry of a shape
403403
///
404404
/// This function must be called by specialized shape objects
405-
/// everytime their points change (ie. the result of either
405+
/// every time their points change (ie. the result of either
406406
/// the getPointCount or getPoint callbacks is different).
407407
///
408408
////////////////////////////////////////////////////////////

include/CSFML/Graphics/VertexArray.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ CSFML_GRAPHICS_API void sfVertexArray_clear(sfVertexArray* vertexArray);
108108
/// If \a vertexCount is less than the current size, existing vertices
109109
/// are removed from the array.
110110
///
111-
/// \param vertexArray Vertex array objet
111+
/// \param vertexArray Vertex array object
112112
/// \param vertexCount New size of the array (number of vertices)
113113
///
114114
////////////////////////////////////////////////////////////
@@ -117,7 +117,7 @@ CSFML_GRAPHICS_API void sfVertexArray_resize(sfVertexArray* vertexArray, size_t
117117
////////////////////////////////////////////////////////////
118118
/// \brief Add a vertex to a vertex array array
119119
///
120-
/// \param vertexArray Vertex array objet
120+
/// \param vertexArray Vertex array object
121121
/// \param vertex Vertex to add
122122
///
123123
////////////////////////////////////////////////////////////
@@ -134,7 +134,7 @@ CSFML_GRAPHICS_API void sfVertexArray_append(sfVertexArray* vertexArray, sfVerte
134134
/// \li As quads
135135
/// The default primitive type is sfPoints.
136136
///
137-
/// \param vertexArray Vertex array objet
137+
/// \param vertexArray Vertex array object
138138
/// \param type Type of primitive
139139
///
140140
////////////////////////////////////////////////////////////
@@ -143,7 +143,7 @@ CSFML_GRAPHICS_API void sfVertexArray_setPrimitiveType(sfVertexArray* vertexArra
143143
////////////////////////////////////////////////////////////
144144
/// \brief Get the type of primitives drawn by a vertex array
145145
///
146-
/// \param vertexArray Vertex array objet
146+
/// \param vertexArray Vertex array object
147147
///
148148
/// \return Primitive type
149149
///
@@ -156,7 +156,7 @@ CSFML_GRAPHICS_API sfPrimitiveType sfVertexArray_getPrimitiveType(sfVertexArray*
156156
/// This function returns the axis-aligned rectangle that
157157
/// contains all the vertices of the array.
158158
///
159-
/// \param vertexArray Vertex array objet
159+
/// \param vertexArray Vertex array object
160160
///
161161
/// \return Bounding rectangle of the vertex array
162162
///

include/CSFML/Graphics/VertexBuffer.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ typedef enum
5656
/// \brief Create a new vertex buffer with a specific
5757
/// sfPrimitiveType and usage specifier.
5858
///
59-
/// Creates the vertex buffer, allocating enough graphcis
59+
/// Creates the vertex buffer, allocating enough graphics
6060
/// memory to hold \p vertexCount vertices, and sets its
6161
/// primitive type to \p type and usage to \p usage.
6262
///

include/CSFML/Network/Ftp.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
////////////////////////////////////////////////////////////
4040
typedef enum
4141
{
42-
sfFtpBinary, ///< Binary mode (file is transfered as a sequence of bytes)
42+
sfFtpBinary, ///< Binary mode (file is transferred as a sequence of bytes)
4343
sfFtpAscii, ///< Text mode using ASCII encoding
4444
sfFtpEbcdic ///< Text mode using EBCDIC encoding
4545
} sfFtpTransferMode;

include/CSFML/Network/Http.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ CSFML_NETWORK_API void sfHttpRequest_setField(sfHttpRequest* httpRequest, const
123123
/// \brief Set a HTTP request method
124124
///
125125
/// See the sfHttpMethod enumeration for a complete list of all
126-
/// the availale methods.
126+
/// the available methods.
127127
/// The method is sfHttpGet by default.
128128
///
129129
/// \param httpRequest HTTP request
@@ -194,7 +194,7 @@ CSFML_NETWORK_API void sfHttpResponse_destroy(sfHttpResponse* httpResponse);
194194
CSFML_NETWORK_API const char* sfHttpResponse_getField(const sfHttpResponse* httpResponse, const char* field);
195195

196196
////////////////////////////////////////////////////////////
197-
/// \brief Get the status code of a HTTP reponse
197+
/// \brief Get the status code of a HTTP response
198198
///
199199
/// The status code should be the first thing to be checked
200200
/// after receiving a response, it defines whether it is a
@@ -287,7 +287,7 @@ CSFML_NETWORK_API void sfHttp_setHost(sfHttp* http, const char* host, unsigned s
287287
/// Warning: this function waits for the server's response and may
288288
/// not return instantly; use a thread if you don't want to block your
289289
/// application, or use a timeout to limit the time to wait. A value
290-
/// of 0 means that the client will use the system defaut timeout
290+
/// of 0 means that the client will use the system default timeout
291291
/// (which is usually pretty long).
292292
///
293293
/// \param http Http object

include/CSFML/Network/SocketSelector.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ CSFML_NETWORK_API void sfSocketSelector_addUdpSocket(sfSocketSelector* selector,
8080
/// removes the pointer that the selector has to it.
8181
///
8282
/// \param selector Socket selector object
83-
/// \param socket POointer to the socket to remove
83+
/// \param socket Pointer to the socket to remove
8484
///
8585
////////////////////////////////////////////////////////////
8686
CSFML_NETWORK_API void sfSocketSelector_removeTcpListener(sfSocketSelector* selector, sfTcpListener* socket);

include/CSFML/Window/Context.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ CSFML_WINDOW_API void sfContext_destroy(sfContext* context);
6262
CSFML_WINDOW_API bool sfContext_isExtensionAvailable(const char* name);
6363

6464
////////////////////////////////////////////////////////////
65-
/// \brief Activate or deactivate explicitely a context
65+
/// \brief Activate or deactivate explicitly a context
6666
///
6767
/// \param context Context object
6868
/// \param active true to activate, false to deactivate

include/CSFML/Window/Joystick.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ CSFML_WINDOW_API sfJoystickIdentification sfJoystick_getIdentification(unsigned
138138
/// \brief Update the states of all joysticks
139139
///
140140
/// This function is used internally by SFML, so you normally
141-
/// don't have to call it explicitely. However, you may need to
141+
/// don't have to call it explicitly. However, you may need to
142142
/// call it if you have no window yet (or no window at all):
143143
/// in this case the joysticks states are not updated automatically.
144144
///

include/CSFML/Window/Window.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ CSFML_WINDOW_API bool sfWindow_pollEvent(sfWindow* window, sfEvent* event);
203203
///
204204
/// This function is blocking: if there's no pending event then
205205
/// it will wait until an event is received.
206-
/// After this function returns (and no error occured),
206+
/// After this function returns (and no error occurred),
207207
/// the \a event object is always valid and filled properly.
208208
/// This function is typically used when you have a thread that
209209
/// is dedicated to events handling: you want to make this thread
@@ -212,7 +212,7 @@ CSFML_WINDOW_API bool sfWindow_pollEvent(sfWindow* window, sfEvent* event);
212212
/// \param window Window object
213213
/// \param event Event to be returned
214214
///
215-
/// \return false if any error occured
215+
/// \return false if any error occurred
216216
///
217217
////////////////////////////////////////////////////////////
218218
CSFML_WINDOW_API bool sfWindow_waitEvent(sfWindow* window, sfEvent* event);

0 commit comments

Comments
 (0)