1. O01eg
  2. ptbe

Commits

O01eg  committed d1ce55a

Add doxygen documentation to the code.

  • Participants
  • Parent commits 60e0e0f
  • Branches default

Comments (0)

Files changed (2)

File include/ptbe/ptbe-client.hpp

View file
 #ifndef _PTBECLIENT_HPP_
 #define _PTBECLIENT_HPP_
 
+/// \brief Main PTBE namespace.
 namespace PTBE
 {
+	/// \brief Managing of client part of the game.
 	class Client
 	{
 	public:
-		Client(int argc,char** argv);
+		/// \desc Constructor.
+		/// \param[in] argc Count of "main" parameters.
+		/// \param[in] argv Vector of "main" parameters.
+		Client(int argc, char** argv);
+
+		/// \desc Run server.
+		/// \return Finish code.	
 		int Run();
 	};
 }

File include/ptbe/ptbe-server.hpp

View file
 #ifndef _PTBESERVER_HPP_
 #define _PTBESERVER_HPP_
 
+/// \desc Main PTBE namespace.
 namespace PTBE
 {
+	/// \desc Managing of server part of the game.
 	class Server
 	{
 	public:
+		/// \desc Constructor.
+		/// \param[in] argc Count of "main" parameters.
+		/// \param[in] argv Vector of "main" parameters.
 		Server(int argc, char** argv);
+
+		/// \desc Run server.
+		/// \return Finish code.
 		int Run();
 	};
 }