Documentation for module: Network

Former-commit-id: 0563349542b717b602d5a6eb7728bd40b2af7e1f

src/Nazara/Network/Network.cpp

@@ -24,9 +24,23 @@
 
 namespace Nz
 {
+	/*!
+	* \ingroup network
+	* \class Nz::Network
+	* \brief Network class that represents the module initializer of Network
+	*/
+
+	/*!
+	* \brief Initializes the Network module
+	* \return true if initialization is successful
+	*
+	* \remark Produces a NazaraNotice
+	* \remark Produces a NazaraError if one submodule failed
+	*/
+
 	bool Network::Initialize()
 	{
-		if (s_moduleReferenceCounter > 0)
+		if (IsInitialized())
 		{
 			s_moduleReferenceCounter++;
 			return true; // Already initialized
@@ -68,11 +82,22 @@ namespace Nz
 		return true;
 	}
 
+	/*!
+	* \brief Checks whether the module is initialized
+	* \return true if module is initialized
+	*/
+
 	bool Network::IsInitialized()
 	{
 		return s_moduleReferenceCounter != 0;
 	}
 
+	/*!
+	* \brief Uninitializes the Core module
+	*
+	* \remark Produces a NazaraNotice
+	*/
+
 	void Network::Uninitialize()
 	{
 		if (s_moduleReferenceCounter != 1)