From 8325db803713cc470d292844499f7de03a1f93f2 Mon Sep 17 00:00:00 2001 From: Gawaboumga Date: Sun, 21 Feb 2016 14:40:47 +0100 Subject: [PATCH] Documentation for Special files of Core Former-commit-id: 6e98fc660ee9dfaa4d8f31da337e2334b4f43442 --- include/Nazara/Core/Config.hpp | 31 +++++++++++++++-------------- include/Nazara/Core/ConfigCheck.hpp | 4 ++-- include/Nazara/Core/DebugOff.hpp | 2 +- include/Nazara/Core/Enums.hpp | 28 +++++++++++++------------- include/Nazara/Core/OffsetOf.hpp | 2 +- readme.md | 2 +- readme_fr.md | 2 +- 7 files changed, 36 insertions(+), 35 deletions(-) diff --git a/include/Nazara/Core/Config.hpp b/include/Nazara/Core/Config.hpp index eee521307..bd67daec6 100644 --- a/include/Nazara/Core/Config.hpp +++ b/include/Nazara/Core/Config.hpp @@ -27,36 +27,36 @@ #ifndef NAZARA_CONFIG_CORE_HPP #define NAZARA_CONFIG_CORE_HPP -/// Chaque modification d'un paramètre du module nécessite une recompilation de celui-ci +/// Each modification of a parameter needs a recompilation of the module -// Précision des réels lors de la transformation en chaîne de caractère (Max. chiffres après la virgule) +// Precision of reals when transformed into string (Max. numbers after the coma) #define NAZARA_CORE_DECIMAL_DIGITS 6 -// Duplique la sortie du log sur le flux de sortie standard (cout) +// Duplicate the log output on the standard output flux (cout) #define NAZARA_CORE_DUPLICATE_LOG_TO_COUT 0 -// Teste les assertions +// Checks the assertions #define NAZARA_CORE_ENABLE_ASSERTS 0 -// Appelle exit dès qu'une assertion est invalide +// Call exit when an assertion is invalid #define NAZARA_CORE_EXIT_ON_ASSERT_FAILURE 1 -// Taille du buffer lors d'une lecture complète d'un fichier (ex: Hash) +// Size of buffer when reading entirely a file (ex: Hash) #define NAZARA_CORE_FILE_BUFFERSIZE 4096 -// Incorpore la table Unicode Character Data (Nécessaires pour faire fonctionner le flag String::HandleUTF8) +// Incorporate the Unicode Character Data table (Necessary to make it work with the flag String::HandleUTF8) #define NAZARA_CORE_INCLUDE_UNICODEDATA 0 -// Utilise le MemoryManager pour gérer les allocations dynamiques (détecte les leaks au prix d'allocations/libérations dynamiques plus lentes) +// Use the MemoryManager to manage dynamic allocations (can detect memory leak but allocations/frees are slower) #define NAZARA_CORE_MANAGE_MEMORY 0 -// Active les tests de sécurité basés sur le code (Conseillé pour le développement) +// Activate the security tests based on the code (Advised for development) #define NAZARA_CORE_SAFE 1 -// Protège les classes des accès concurrentiels +// Protect the classes against data race #define NAZARA_CORE_THREADSAFE 1 -// Les classes à protéger des accès concurrentiels +// Classes to protect against data race #define NAZARA_THREADSAFETY_CLOCK 0 // Clock #define NAZARA_THREADSAFETY_DIRECTORY 1 // Directory #define NAZARA_THREADSAFETY_DYNLIB 1 // DynLib @@ -64,18 +64,19 @@ #define NAZARA_THREADSAFETY_LOG 1 // Log #define NAZARA_THREADSAFETY_REFCOUNTED 1 // RefCounted -// Le nombre de spinlocks à utiliser avec les sections critiques de Windows (0 pour désactiver) +// Number of spinlocks to use with the Windows critical sections (0 to disable) #define NAZARA_CORE_WINDOWS_CS_SPINLOCKS 4096 -// Optimise l'implémentation Windows avec certaines avancées de Windows vista (Casse la compatibilité XP) +// Optimize the Windows implementation with technologies of Windows vista (and greather) (Break the compatibility with XP) #define NAZARA_CORE_WINDOWS_VISTA 0 + /* -// Règle le temps entre le réveil du thread des timers et l'activation d'un timer (En millisecondes) +// Sets the time between waking thread timers and activating a timer (in milliseconds) #define NAZARA_CORE_TIMER_WAKEUPTIME 10 */ -/// Vérification des valeurs et types de certaines constantes +/// Checking the values and types of certain constants #include #if defined(NAZARA_STATIC) diff --git a/include/Nazara/Core/ConfigCheck.hpp b/include/Nazara/Core/ConfigCheck.hpp index 310567eef..8329f4ff0 100644 --- a/include/Nazara/Core/ConfigCheck.hpp +++ b/include/Nazara/Core/ConfigCheck.hpp @@ -7,12 +7,12 @@ #ifndef NAZARA_CONFIG_CHECK_CORE_HPP #define NAZARA_CONFIG_CHECK_CORE_HPP -/// Ce fichier sert à vérifier la valeur des constantes du fichier Config.hpp +/// This file is used to check the constant values defined in Config.hpp #include #define NazaraCheckTypeAndVal(name, type, op, val, err) static_assert(std::is_ ##type ::value && name op val, #type err) -// On force la valeur de MANAGE_MEMORY en mode debug +// We fore the value of MANAGE_MEMORY in debug #if defined(NAZARA_DEBUG) && !NAZARA_CORE_MANAGE_MEMORY #undef NAZARA_CORE_MANAGE_MEMORY #define NAZARA_CORE_MANAGE_MEMORY 0 diff --git a/include/Nazara/Core/DebugOff.hpp b/include/Nazara/Core/DebugOff.hpp index e042eff24..62788ee15 100644 --- a/include/Nazara/Core/DebugOff.hpp +++ b/include/Nazara/Core/DebugOff.hpp @@ -2,7 +2,7 @@ // This file is part of the "Nazara Engine - Core module" // For conditions of distribution and use, see copyright notice in Config.hpp -// On suppose que Debug.hpp a déjà été inclus, tout comme Config.hpp +// We assume that Debug.hpp has already been included, same thing for Config.hpp #if NAZARA_CORE_MANAGE_MEMORY #undef delete #undef new diff --git a/include/Nazara/Core/Enums.hpp b/include/Nazara/Core/Enums.hpp index a261f2bd3..0c0530489 100644 --- a/include/Nazara/Core/Enums.hpp +++ b/include/Nazara/Core/Enums.hpp @@ -19,9 +19,9 @@ namespace Nz enum CursorPosition { - CursorPosition_AtBegin, // Début du fichier - CursorPosition_AtCurrent, // Position du pointeur - CursorPosition_AtEnd, // Fin du fichier + CursorPosition_AtBegin, // beginning of the file + CursorPosition_AtCurrent, // Position of the cursor + CursorPosition_AtEnd, // End of the file CursorPosition_Max = CursorPosition_AtEnd }; @@ -45,7 +45,7 @@ namespace Nz ErrorFlag_ThrowException = 0x4, ErrorFlag_ThrowExceptionDisabled = 0x8, - ErrorFlag_Max = ErrorFlag_ThrowExceptionDisabled*2-1 + ErrorFlag_Max = ErrorFlag_ThrowExceptionDisabled * 2 - 1 }; enum ErrorType @@ -75,18 +75,18 @@ namespace Nz enum OpenModeFlags { - OpenMode_NotOpen = 0x00, // Utilise le mode d'ouverture actuel + OpenMode_NotOpen = 0x00, // Use the current mod of opening - OpenMode_Append = 0x01, // Empêche l'écriture sur la partie déjà existante et met le curseur à la fin - OpenMode_Lock = 0x02, // Empêche le fichier d'être modifié tant qu'il est ouvert - OpenMode_ReadOnly = 0x04, // Ouvre uniquement en lecture - OpenMode_Text = 0x10, // Ouvre en mode texte - OpenMode_Truncate = 0x20, // Créé le fichier s'il n'existe pas et le vide s'il existe - OpenMode_WriteOnly = 0x40, // Ouvre uniquement en écriture, créé le fichier s'il n'existe pas + OpenMode_Append = 0x01, // Disable writing on existing parts and put the cursor at the end + OpenMode_Lock = 0x02, // Disable modifying the file before it is open + OpenMode_ReadOnly = 0x04, // Open in read only + OpenMode_Text = 0x10, // Open in text mod + OpenMode_Truncate = 0x20, // Create the file if it doesn't exist and empty it if it exists + OpenMode_WriteOnly = 0x40, // Open in write only, create the file if it doesn't exist - OpenMode_ReadWrite = OpenMode_ReadOnly | OpenMode_WriteOnly, // Ouvre en lecture/écriture + OpenMode_ReadWrite = OpenMode_ReadOnly | OpenMode_WriteOnly, // Open in read and write - OpenMode_Max = OpenMode_WriteOnly*2 - 1 + OpenMode_Max = OpenMode_WriteOnly * 2 - 1 }; enum ParameterType @@ -177,7 +177,7 @@ namespace Nz StreamOption_Sequential = 0x1, StreamOption_Text = 0x2, - StreamOption_Max = StreamOption_Text*2 - 1 + StreamOption_Max = StreamOption_Text * 2 - 1 }; enum Ternary diff --git a/include/Nazara/Core/OffsetOf.hpp b/include/Nazara/Core/OffsetOf.hpp index 7b97a44e2..d6596dcf2 100644 --- a/include/Nazara/Core/OffsetOf.hpp +++ b/include/Nazara/Core/OffsetOf.hpp @@ -7,7 +7,7 @@ #ifndef NAZARA_OFFSETOF_HPP #define NAZARA_OFFSETOF_HPP -// Par "Jesse Good" de SO: +// By "Jesse Good" from SO: // http://stackoverflow.com/questions/12811330/c-compile-time-offsetof-inside-a-template?answertab=votes#tab-top namespace Nz diff --git a/readme.md b/readme.md index ea7595a96..90a30fda5 100644 --- a/readme.md +++ b/readme.md @@ -45,4 +45,4 @@ Links - **RafBill** and **Raakz:** Finding bugs and/or testing - **Fissal "DrFisher" Hannoun**: Helping a lot in architecture design - **Alexandre "Danman" Janniaux**: Helping making the POSIX implementation -- **Gawaboumga**: Improving the engine code by merging on GitHub +- **Youri "Gawaboumga" Hubaut**: Improving the engine code by merging on GitHub diff --git a/readme_fr.md b/readme_fr.md index bc3364350..fd0f42e7b 100644 --- a/readme_fr.md +++ b/readme_fr.md @@ -45,4 +45,4 @@ Liens - **RafBill** et **Raakz:** Recherche de bugs et/ou tests - **Fissal "DrFisher" Hannoun**: Aide et conseils lors de la conception de l'architecture du moteur - **Alexandre "Danman" Janniaux**: Aide sur l'implémentation POSIX -- **Gawaboumga**: Amélioration du code via le merging sur GitHub +- **Youri "Gawaboumga" Hubaut**: Amélioration du code via le merging sur GitHub