TheStarport / FLHook

A Server Improvement for Freelancer.
GNU General Public License v3.0
30 stars 16 forks source link

Ensure that all configs have comments Doxy-style comments applied to their fields #184

Closed Lazrius closed 1 year ago

Lazrius commented 1 year ago

With the amount of configs and the size of FLHookConfig, we should make it apparent what variables do, and allow it to be auto generated. Example:


    struct Plugins final : Reflectable
    {
        bool loadAllPlugins = true;
        std::vector<std::string> plugins = {};
    };

to:

    struct Plugins final : Reflectable
    {
        //! Load all plugins found the "plugins" folder, and ignore the array of specific plugins.
        bool loadAllPlugins = true;
        //! Array of plugin files relative to the plugins folder - e.g. [ "afk.dll", "betting.dll" ]
        std::vector<std::string> plugins = {};
    };
Aingar commented 1 year ago

All the remaining doxy-less configs were done in #226