Skip to content

Commit

Permalink
📚 Doxygen: added module 'Scripting'.
Browse files Browse the repository at this point in the history
  • Loading branch information
ohlidalp authored and Petr Ohlídal committed Apr 9, 2022
1 parent cdfe0ae commit 4bde1cb
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 5 deletions.
3 changes: 3 additions & 0 deletions doc/doxygen/Modules.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,7 @@
/// @defgroup ConsoleCmd Console commmands
/// Built-in console commands.

/// @defgroup Scripting Scripting
/// Game scripting subsystem using AngelScript.


9 changes: 4 additions & 5 deletions source/main/scripting/GameScript.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,8 @@

namespace RoR {

struct curlMemoryStruct
{
char* memory;
size_t size;
};
/// @addtogroup Scripting
/// @{

/**
* @brief Proxy class that can be called by script functions
Expand Down Expand Up @@ -379,4 +376,6 @@ class GameScript : public ZeroedMemoryAllocator
bool HaveMainCamera(const char* func_name); //!< Helper; Check if main camera exists, log warning if not.
};

/// @} //addtogroup Scripting

} // namespace RoR
4 changes: 4 additions & 0 deletions source/main/scripting/LocalStorage.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@
#include <angelscript.h>
#include "ImprovedConfigFile.h"

/// @addtogroup Scripting
/// @{

void registerLocalStorage(AngelScript::asIScriptEngine* engine);
void scriptLocalStorageFactory_Generic(AngelScript::asIScriptGeneric* gen);
void scriptLocalStorageFactory2_Generic(AngelScript::asIScriptGeneric* gen);
Expand Down Expand Up @@ -108,3 +111,4 @@ class LocalStorage : public ImprovedConfigFile
bool cgflag;
};

/// @} //addtogroup Scripting
4 changes: 4 additions & 0 deletions source/main/scripting/OgreScriptBuilder.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@

#include <angelscript.h>

/// @addtogroup Scripting
/// @{

// our own class that wraps the CScriptBuilder and just overwrites the file loading parts
// to use the ogre resource system
class OgreScriptBuilder : public AngelScript::CScriptBuilder, public ZeroedMemoryAllocator
Expand All @@ -42,3 +45,4 @@ class OgreScriptBuilder : public AngelScript::CScriptBuilder, public ZeroedMemor
int LoadScriptSection(const char* filename);
};

/// @} //addtogroup Scripting
5 changes: 5 additions & 0 deletions source/main/scripting/ScriptEngine.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@

namespace RoR {

/// @addtogroup Scripting
/// @{

enum class ScriptCategory
{
INVALID,
Expand Down Expand Up @@ -213,6 +216,8 @@ void RegisterImGuiBindings(AngelScript::asIScriptEngine* engine);
/// Registers RoR::InputEngine, defined in InputEngineAngelscript.cpp
void registerInputEngine(AngelScript::asIScriptEngine* engine);

/// @} //addtogroup Scripting

} // namespace RoR

#else // USE_ANGELSCRIPT
Expand Down

0 comments on commit 4bde1cb

Please # to comment.