From 085bb5085274df98fa5a57c4ac9922a8620dcfa7 Mon Sep 17 00:00:00 2001
From: Jan Travnicek <Jan.Travnicek@fit.cvut.cz>
Date: Tue, 19 Feb 2019 14:19:15 +0100
Subject: [PATCH] update documentation of builtin commands

---
 alib2cli/src/builtin/Dot.cpp       | 13 +++++++++++--
 alib2cli/src/builtin/Dot.h         | 16 +++++++++++++++-
 alib2cli/src/builtin/ReadFile.cpp  |  6 +++++-
 alib2cli/src/builtin/ReadFile.h    | 10 ++++++++++
 alib2cli/src/builtin/WriteFile.cpp |  6 +++++-
 alib2cli/src/builtin/WriteFile.h   | 10 ++++++++++
 6 files changed, 56 insertions(+), 5 deletions(-)

diff --git a/alib2cli/src/builtin/Dot.cpp b/alib2cli/src/builtin/Dot.cpp
index 9f6932e1e5..3b11b61312 100644
--- a/alib2cli/src/builtin/Dot.cpp
+++ b/alib2cli/src/builtin/Dot.cpp
@@ -39,8 +39,17 @@ void Dot::dot ( const std::string & data, const std::string & outputType, const
 		throw exception::CommonException ( "The dot command exited unsuccessfuly. Return value was " + ext::to_string ( res ) + "." );
 }
 
-auto DotTx11 = registration::AbstractRegister < Dot, void, const std::string & > ( Dot::dot, abstraction::AlgorithmCategories::AlgorithmCategory::DEFAULT, "dot_data" );
-auto DotFile = registration::AbstractRegister < Dot, void, const std::string &, const std::string &, const std::string & > ( Dot::dot, abstraction::AlgorithmCategories::AlgorithmCategory::DEFAULT, "dot_data", "output_type", "file_name" );
+auto DotTx11 = registration::AbstractRegister < Dot, void, const std::string & > ( Dot::dot, abstraction::AlgorithmCategories::AlgorithmCategory::DEFAULT, "dot_data" ).setDocumentation (
+"Cli builtin command for DOT format visualization\n\
+\n\
+@param dot a string containing dot data" );
+
+auto DotFile = registration::AbstractRegister < Dot, void, const std::string &, const std::string &, const std::string & > ( Dot::dot, abstraction::AlgorithmCategories::AlgorithmCategory::DEFAULT, "dot_data", "output_type", "file_name" ).setDocumentation (
+"Cli builtin command for DOT format visualization\n\
+\n\
+param data a string containing dot data\n\
+param outputType the type of dot created image\n\
+param outputFile the destination file name" );
 
 } /* namespace builtin */
 
diff --git a/alib2cli/src/builtin/Dot.h b/alib2cli/src/builtin/Dot.h
index 1d9a250cac..0bfff37f2c 100644
--- a/alib2cli/src/builtin/Dot.h
+++ b/alib2cli/src/builtin/Dot.h
@@ -15,12 +15,26 @@ namespace cli {
 
 namespace builtin {
 
+/**
+ * Dot visualisation executioner.
+ *
+ */
 class Dot {
 public:
 	/**
-	 * Cli builtin for DOT format visualization
+	 * Cli builtin command for DOT format visualization
+	 *
+	 * \param dot a string containing dot data
 	 */
 	static void dot( const std::string & dot );
+
+	/**
+	 * Cli builtin command for DOT format visualization
+	 *
+	 * \param data a string containing dot data
+	 * \param outputType the type of dot created image
+	 * \param outputFile the destination file name
+	 */
 	static void dot ( const std::string & data, const std::string & outputType, const std::string & outputFile );
 
 private:
diff --git a/alib2cli/src/builtin/ReadFile.cpp b/alib2cli/src/builtin/ReadFile.cpp
index ba920b4973..4e7ec3da4b 100644
--- a/alib2cli/src/builtin/ReadFile.cpp
+++ b/alib2cli/src/builtin/ReadFile.cpp
@@ -31,7 +31,11 @@ std::string ReadFile::read ( const std::string & filename ) {
 	}
 }
 
-auto ReadFileString = registration::AbstractRegister < ReadFile, std::string, const std::string & > ( ReadFile::read );
+auto ReadFileString = registration::AbstractRegister < ReadFile, std::string, const std::string & > ( ReadFile::read, "filename" ).setDocumentation (
+"Reads the content of a file into a string.\n\
+\n\
+@param filename the name of read file\n\
+@return the content of the file" );
 
 } /* namespace builtin */
 
diff --git a/alib2cli/src/builtin/ReadFile.h b/alib2cli/src/builtin/ReadFile.h
index 28d47dd51f..97671f41b8 100644
--- a/alib2cli/src/builtin/ReadFile.h
+++ b/alib2cli/src/builtin/ReadFile.h
@@ -14,8 +14,18 @@ namespace cli {
 
 namespace builtin {
 
+/**
+ * File reader command.
+ */
 class ReadFile {
 public:
+	/**
+	 * Reads the content of a file into a string.
+	 *
+	 * \param filename the name of read file
+	 *
+	 * \return the content of the file
+	 */
 	static std::string read ( const std::string & filename );
 };
 
diff --git a/alib2cli/src/builtin/WriteFile.cpp b/alib2cli/src/builtin/WriteFile.cpp
index 984884734e..af0635a036 100644
--- a/alib2cli/src/builtin/WriteFile.cpp
+++ b/alib2cli/src/builtin/WriteFile.cpp
@@ -28,7 +28,11 @@ void WriteFile::write ( const std::string & filename, const std::string & data )
 	}
 }
 
-auto WriteFileString = registration::AbstractRegister < WriteFile, void, const std::string &, const std::string & > ( WriteFile::write );
+auto WriteFileString = registration::AbstractRegister < WriteFile, void, const std::string &, const std::string & > ( WriteFile::write, "filename", "data" ).setDocumentation (
+"Writes some string into a file.\n\
+\n\
+@param filename the name of written file\n\
+@param data the content of the file" );
 
 } /* namespace builtin */
 
diff --git a/alib2cli/src/builtin/WriteFile.h b/alib2cli/src/builtin/WriteFile.h
index 83a04ed7a2..dd5b13d950 100644
--- a/alib2cli/src/builtin/WriteFile.h
+++ b/alib2cli/src/builtin/WriteFile.h
@@ -14,8 +14,18 @@ namespace cli {
 
 namespace builtin {
 
+/**
+ * File writting command.
+ *
+ */
 class WriteFile {
 public:
+	/**
+	 * Writes some string into a file.
+	 *
+	 * \param filename the name of written file
+	 * \param data the content of the file
+	 */
 	static void write ( const std::string & filename, const std::string & data );
 };
 
-- 
GitLab