Fix various documentation and formatting issues.

[user/henk/code/inspircd.git] / include / configreader.h

diff --git a/include/configreader.h b/include/configreader.h
index 511bedbee2618ecfb42977844d4455aed4096939..4deef83f49a7b31c8c26f683bf078cea7d55f17d 100644 (file)
--- a/include/configreader.h
+++ b/include/configreader.h
@@ -1,11 +1,17 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
- *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
- *   Copyright (C) 2006-2008 Craig Edwards <craigedwards@brainbox.cc>
- *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
- *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
+ *   Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2018 Chris Novakovic <chrisnovakovic@users.noreply.github.com>
+ *   Copyright (C) 2013-2014, 2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
+ *   Copyright (C) 2012-2014, 2016-2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007-2008 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
  * redistribute it and/or modify it under the terms of the GNU General Public
@@ -160,12 +166,13 @@ struct CommandLineConf
         */
        bool writepid;
 
-       /** Saved argc from startup
-        */
+       /* Whether the --runasroot option was specified at boot. */
+       bool runasroot;
+
+       /** Saved argc from startup. */
        int argc;
 
-       /** Saved argv from startup
-        */
+       /** Saved argv from startup. */
        char** argv;
 };
 
@@ -490,13 +497,23 @@ class CoreExport ConfigReaderThread : public Thread
        bool IsDone() { return done; }
 };
 
+/** Represents the status of a config load. */
 class CoreExport ConfigStatus
 {
  public:
+       /** Whether this is the initial config load. */
+       bool const initial;
+
+       /** The user who initiated the config load or NULL if not initiated by a user. */
        User* const srcuser;
 
-       ConfigStatus(User* user = NULL)
-               : srcuser(user)
+       /** Initializes a new instance of the ConfigStatus class.
+        * @param user The user who initiated the config load or NULL if not initiated by a user.
+        * @param isinitial Whether this is the initial config load.
+        */
+       ConfigStatus(User* user = NULL, bool isinitial = false)
+               : initial(isinitial)
+               , srcuser(user)
        {
        }
 };