Unverified Commit 1bfcbfaf authored by RobLoach's avatar RobLoach Committed by GitHub
Browse files

0.23.1 (#268)

* Add a force clean of the submodules

* Add API Docs

* 0.23.1
parent 2788bcaa
......@@ -4,6 +4,10 @@ All notable changes to [ChaiLove](https://github.com/RobLoach/ChaiLove) will be
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## 0.23.1 - 2018-08-28
### Fixes
- Clean up of git submodules
## 0.23.0 - 2018-08-27
### Chores
- Updated dependencies
......
......@@ -31,7 +31,8 @@ clean:
rm -f $(TARGET) $(OBJECTS)
git clean -xdf
rm -rf vendor
git submodule update --init --recursive
git reset --hard HEAD
git submodule update -f --init --recursive
git submodule foreach --recursive git clean -xfd
git submodule foreach --recursive git reset --hard HEAD
......
......@@ -23,7 +23,7 @@ PROJECT_NAME = "ChaiLove API"
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = "0.23.0"
PROJECT_NUMBER = "0.23.1"
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
......
......@@ -48,8 +48,8 @@
#define CHAILOVE_VERSION_MAJOR 0
#define CHAILOVE_VERSION_MINOR 23
#define CHAILOVE_VERSION_PATCH 0
#define CHAILOVE_VERSION_STRING "0.23.0"
#define CHAILOVE_VERSION_PATCH 1
#define CHAILOVE_VERSION_STRING "0.23.1"
#include "SDL.h"
#include "libretro.h"
......
......@@ -19,7 +19,7 @@ namespace love {
*
* @code
* def conf(t) {
* t.version = "0.23.0" // Version of ChaiLove
* t.version = "0.23.1" // Version of ChaiLove
* t.identity = "mygame" // Machine name of your game
* t.window.title = "My Game" // Human-readable name
* t.window.width = 1024 // Game width
......
......@@ -18,6 +18,14 @@ class data {
* @return Compressed data in the form of a string.
*
* @see love.data.decompress
*
* @code
* var message = "Hello World!"
* var compressed = love.data.compress(message)
* print(compressed)
* var decompressed = love.data.decompress(compressed)
* print(decompressed)
* @endcode
*/
std::string compress(const std::string& str, int level);
std::string compress(const std::string& str);
......@@ -42,6 +50,12 @@ class data {
* @todo Add sha256, sha512, etc.
*
* @return Raw message digest string.
*
* @code
* var message = "Hello World!"
* var hash = love.data.hash("md5", message)
* print(hash)
* @endcode
*/
std::string hash(const std::string& hashFunction, const std::string& data);
......
......@@ -44,11 +44,25 @@ class filesystem {
* @param file The name (and path) of the file.
*
* @return The contents of the file.
*
* @code
* var contents = love.filesystem.read("test.txt")
* print(contents)
* @endcode
*/
std::string read(const std::string& filename);
/**
* Check whether a file or directory exists.
*
* @code
* if (love.filesystem.exists("test.txt")) {
* print("The test.txt file exists")
* }
* else {
* print("The test.txt file does not exist")
* }
* @endcode
*/
bool exists(const std::string& file);
......
......@@ -95,6 +95,10 @@ class graphics {
* @param filename The filepath to the image file.
*
* @return An image object which can be drawn to the screen.
*
* @code
* var logo = love.graphics.newImage("logo.png")
* @endcode
*/
Image* newImage(const std::string& filename);
......
......@@ -18,6 +18,12 @@ class math {
* @param max (1.0f) The max value.
*
* @return A number between the two given min and max values.
*
* @code
* love.math.random(5, 10) // 5-10
* love.math.random(10) // 0-10
* love.math.random() // 0.0f-1.0f
* @endcode
*/
float random(float min, float max);
float random(float max);
......
......@@ -52,7 +52,7 @@ class script {
* t.console = false
*
* // The ChaiLove version this game was made for.
* t.version = "0.23.0"
* t.version = "0.23.1"
*
* // The width and height of the game.
* t.window.width = 1024
......
......@@ -22,6 +22,11 @@ class timer {
* Returns the current frames per second.
*
* @return The current FPS.
*
* @code
* var fps = love.timer.getFPS()
* print("FPS: " + to_string(fps))
* @endcode
*/
int getFPS();
......
......@@ -15,7 +15,7 @@ def conf(t) {
t.window.width = 460
t.window.height = 320
t.console = true
t.version = "0.23.0"
t.version = "0.23.1"
}
def load() {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment