diff --git a/alib2cli/src/builtin/Dot.cpp b/alib2cli/src/builtin/Dot.cpp index 9f6932e1e5cafd030577d2d1c79e33331ed92809..3b11b61312105e6c0390efa027476c26513bee83 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 1d9a250cac55aa14025713a2870a888da16fd80d..0bfff37f2c5acb2b2d6bdf75f4c8da836bb8ebac 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 ba920b49731d9cdb421c7abab42dec7b21ae983a..4e7ec3da4b3790ead353b0a1024a9b7dc38f0b2b 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 28d47dd51ff47e510e7f957d6b89e5a56d1dff3c..97671f41b8385a3d5cab295307b9b5c7ebffbf87 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 984884734ec64a4c247b70a5e4ac3ad99094dfb3..af0635a0366bb60a5b6257070cbb5c8b10a8acd3 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 83a04ed7a2d9c0318187f55cb6eb713a4d1a72f1..dd5b13d95042677ef7b0c0a6c7735f1cb2a6eb98 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 ); };