From db753ad97fdce173a82bdcb501ae142c338c6ccf Mon Sep 17 00:00:00 2001 From: Ray Date: Tue, 1 Jun 2021 20:19:39 +0200 Subject: [PATCH] Updated raylib syntax analysis (markdown) --- raylib-syntax-analysis.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/raylib-syntax-analysis.md b/raylib-syntax-analysis.md index 37e144e..428c13e 100644 --- a/raylib-syntax-analysis.md +++ b/raylib-syntax-analysis.md @@ -1,8 +1,8 @@ raylib is a simple and easy-to-use library to enjoy videogames programing... but, **what makes the library simple and easy-to-use?** For many users the first approach to the library is through its API, so, here it is a small analysis of the API from a **syntactic point of view**. -How are the functions structured? Which words are used? How many parameters are exposed? How intuitive is it to understand or even guess every function/structure/enum when required? Syntax is the set of rules, principles, and processes that govern the structure of sentences in a given language, including word order. +How are the functions structured? Which words are used? How many parameters are exposed? How intuitive is it to understand or even guess every function/structure/enum when required? Syntax is the set of rules, principles, and processes that govern the structure of sentences in a given language and defines how we understand it. -To do this analysis a [`raylib.h` parser](https://github.com/raysan5/raylib/tree/master/parser) has been created. That parser dissects API into small pieces; in the future it can also be useful for automatic docs and binding generation! +To do this analysis a [`raylib.h` parser](https://github.com/raysan5/raylib/tree/master/parser) has been created. That parser dissects API into small pieces to automatize some parts of the analysis; actually, this parser can also be useful for automatic docs and bindings generation! The analysis is organized in 3 parts, one for each API element analyzed: