Skip to content

Commit

Permalink
Fix typos in public documentation
Browse files Browse the repository at this point in the history
Typos found with codespell tool
  • Loading branch information
ChrisThrasher committed Aug 25, 2024
1 parent 55fe064 commit fe8d8a9
Show file tree
Hide file tree
Showing 11 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion include/CSFML/Graphics/RenderWindow.h
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ CSFML_GRAPHICS_API bool sfRenderWindow_pollEvent(sfRenderWindow* renderWindow, s
/// \param renderWindow Render window object
/// \param event Event to fill
///
/// \return false if an error occured
/// \return false if an error occurred
///
////////////////////////////////////////////////////////////
CSFML_GRAPHICS_API bool sfRenderWindow_waitEvent(sfRenderWindow* renderWindow, sfEvent* event);
Expand Down
2 changes: 1 addition & 1 deletion include/CSFML/Graphics/Shape.h
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ CSFML_GRAPHICS_API sfFloatRect sfShape_getGlobalBounds(const sfShape* shape);
/// \brief Recompute the internal geometry of a shape
///
/// This function must be called by specialized shape objects
/// everytime their points change (ie. the result of either
/// every time their points change (ie. the result of either
/// the getPointCount or getPoint callbacks is different).
///
////////////////////////////////////////////////////////////
Expand Down
10 changes: 5 additions & 5 deletions include/CSFML/Graphics/VertexArray.h
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ CSFML_GRAPHICS_API void sfVertexArray_clear(sfVertexArray* vertexArray);
/// If \a vertexCount is less than the current size, existing vertices
/// are removed from the array.
///
/// \param vertexArray Vertex array objet
/// \param vertexArray Vertex array object
/// \param vertexCount New size of the array (number of vertices)
///
////////////////////////////////////////////////////////////
Expand All @@ -117,7 +117,7 @@ CSFML_GRAPHICS_API void sfVertexArray_resize(sfVertexArray* vertexArray, size_t
////////////////////////////////////////////////////////////
/// \brief Add a vertex to a vertex array array
///
/// \param vertexArray Vertex array objet
/// \param vertexArray Vertex array object
/// \param vertex Vertex to add
///
////////////////////////////////////////////////////////////
Expand All @@ -134,7 +134,7 @@ CSFML_GRAPHICS_API void sfVertexArray_append(sfVertexArray* vertexArray, sfVerte
/// \li As quads
/// The default primitive type is sfPoints.
///
/// \param vertexArray Vertex array objet
/// \param vertexArray Vertex array object
/// \param type Type of primitive
///
////////////////////////////////////////////////////////////
Expand All @@ -143,7 +143,7 @@ CSFML_GRAPHICS_API void sfVertexArray_setPrimitiveType(sfVertexArray* vertexArra
////////////////////////////////////////////////////////////
/// \brief Get the type of primitives drawn by a vertex array
///
/// \param vertexArray Vertex array objet
/// \param vertexArray Vertex array object
///
/// \return Primitive type
///
Expand All @@ -156,7 +156,7 @@ CSFML_GRAPHICS_API sfPrimitiveType sfVertexArray_getPrimitiveType(sfVertexArray*
/// This function returns the axis-aligned rectangle that
/// contains all the vertices of the array.
///
/// \param vertexArray Vertex array objet
/// \param vertexArray Vertex array object
///
/// \return Bounding rectangle of the vertex array
///
Expand Down
2 changes: 1 addition & 1 deletion include/CSFML/Graphics/VertexBuffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ typedef enum
/// \brief Create a new vertex buffer with a specific
/// sfPrimitiveType and usage specifier.
///
/// Creates the vertex buffer, allocating enough graphcis
/// Creates the vertex buffer, allocating enough graphics
/// memory to hold \p vertexCount vertices, and sets its
/// primitive type to \p type and usage to \p usage.
///
Expand Down
2 changes: 1 addition & 1 deletion include/CSFML/Network/Ftp.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
////////////////////////////////////////////////////////////
typedef enum
{
sfFtpBinary, ///< Binary mode (file is transfered as a sequence of bytes)
sfFtpBinary, ///< Binary mode (file is transferred as a sequence of bytes)
sfFtpAscii, ///< Text mode using ASCII encoding
sfFtpEbcdic ///< Text mode using EBCDIC encoding
} sfFtpTransferMode;
Expand Down
6 changes: 3 additions & 3 deletions include/CSFML/Network/Http.h
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ CSFML_NETWORK_API void sfHttpRequest_setField(sfHttpRequest* httpRequest, const
/// \brief Set a HTTP request method
///
/// See the sfHttpMethod enumeration for a complete list of all
/// the availale methods.
/// the available methods.
/// The method is sfHttpGet by default.
///
/// \param httpRequest HTTP request
Expand Down Expand Up @@ -194,7 +194,7 @@ CSFML_NETWORK_API void sfHttpResponse_destroy(sfHttpResponse* httpResponse);
CSFML_NETWORK_API const char* sfHttpResponse_getField(const sfHttpResponse* httpResponse, const char* field);

////////////////////////////////////////////////////////////
/// \brief Get the status code of a HTTP reponse
/// \brief Get the status code of a HTTP response
///
/// The status code should be the first thing to be checked
/// after receiving a response, it defines whether it is a
Expand Down Expand Up @@ -287,7 +287,7 @@ CSFML_NETWORK_API void sfHttp_setHost(sfHttp* http, const char* host, unsigned s
/// Warning: this function waits for the server's response and may
/// not return instantly; use a thread if you don't want to block your
/// application, or use a timeout to limit the time to wait. A value
/// of 0 means that the client will use the system defaut timeout
/// of 0 means that the client will use the system default timeout
/// (which is usually pretty long).
///
/// \param http Http object
Expand Down
2 changes: 1 addition & 1 deletion include/CSFML/Network/SocketSelector.h
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ CSFML_NETWORK_API void sfSocketSelector_addUdpSocket(sfSocketSelector* selector,
/// removes the pointer that the selector has to it.
///
/// \param selector Socket selector object
/// \param socket POointer to the socket to remove
/// \param socket Pointer to the socket to remove
///
////////////////////////////////////////////////////////////
CSFML_NETWORK_API void sfSocketSelector_removeTcpListener(sfSocketSelector* selector, sfTcpListener* socket);
Expand Down
2 changes: 1 addition & 1 deletion include/CSFML/Window/Context.h
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ CSFML_WINDOW_API void sfContext_destroy(sfContext* context);
CSFML_WINDOW_API bool sfContext_isExtensionAvailable(const char* name);

////////////////////////////////////////////////////////////
/// \brief Activate or deactivate explicitely a context
/// \brief Activate or deactivate explicitly a context
///
/// \param context Context object
/// \param active true to activate, false to deactivate
Expand Down
2 changes: 1 addition & 1 deletion include/CSFML/Window/Joystick.h
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ CSFML_WINDOW_API sfJoystickIdentification sfJoystick_getIdentification(unsigned
/// \brief Update the states of all joysticks
///
/// This function is used internally by SFML, so you normally
/// don't have to call it explicitely. However, you may need to
/// don't have to call it explicitly. However, you may need to
/// call it if you have no window yet (or no window at all):
/// in this case the joysticks states are not updated automatically.
///
Expand Down
4 changes: 2 additions & 2 deletions include/CSFML/Window/Window.h
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ CSFML_WINDOW_API bool sfWindow_pollEvent(sfWindow* window, sfEvent* event);
///
/// This function is blocking: if there's no pending event then
/// it will wait until an event is received.
/// After this function returns (and no error occured),
/// After this function returns (and no error occurred),
/// the \a event object is always valid and filled properly.
/// This function is typically used when you have a thread that
/// is dedicated to events handling: you want to make this thread
Expand All @@ -212,7 +212,7 @@ CSFML_WINDOW_API bool sfWindow_pollEvent(sfWindow* window, sfEvent* event);
/// \param window Window object
/// \param event Event to be returned
///
/// \return false if any error occured
/// \return false if any error occurred
///
////////////////////////////////////////////////////////////
CSFML_WINDOW_API bool sfWindow_waitEvent(sfWindow* window, sfEvent* event);
Expand Down
4 changes: 2 additions & 2 deletions include/CSFML/Window/WindowBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ CSFML_WINDOW_API bool sfWindowBase_pollEvent(sfWindowBase* windowBase, sfEvent*
///
/// This function is blocking: if there's no pending event then
/// it will wait until an event is received.
/// After this function returns (and no error occured),
/// After this function returns (and no error occurred),
/// the \a event object is always valid and filled properly.
/// This function is typically used when you have a thread that
/// is dedicated to events handling: you want to make this thread
Expand All @@ -175,7 +175,7 @@ CSFML_WINDOW_API bool sfWindowBase_pollEvent(sfWindowBase* windowBase, sfEvent*
/// \param windowBase Window object
/// \param event Event to be returned
///
/// \return false if any error occured
/// \return false if any error occurred
///
////////////////////////////////////////////////////////////
CSFML_WINDOW_API bool sfWindowBase_waitEvent(sfWindowBase* windowBase, sfEvent* event);
Expand Down

0 comments on commit fe8d8a9

Please sign in to comment.