Commit 3ab97a24 authored by Pierre Aubert's avatar Pierre Aubert
Browse files

Update doc

parent f8269f56
Pipeline #122445 passed with stages
in 6 minutes and 26 seconds
......@@ -93,10 +93,10 @@ The files \textbf{Shadok.h} and \textbf{Shadok.cpp} describe the internal repres
The files are named \textbf{shadok.*} because the initial file was named \textbf{shadok.pparser}. Each \textbf{*.pparser} file will gives two files in the internal representation.
\end{advise}
File \textbf{Shadok.h} :
File \textbf{shadok.h} :
\cpp{../../build/TESTS/TEST_SHADOK_LIST/shadok.h}
File \textbf{Shadok.cpp} :
File \textbf{shadok.cpp} :
\cpp{../../build/TESTS/TEST_SHADOK_LIST/shadok.cpp}
......
......@@ -13,7 +13,7 @@
using namespace std;
///Get the vector of different classes used by the operators
/** @param[out] vecClass : vector of used classes
/** @param[out] mapOp : map of used classes
* @param vecOp : vector of operators
*/
void repr_cpp_operatorGetClass(PMapVecOperator & mapOp, const PVecOperator & vecOp){
......@@ -73,6 +73,7 @@ std::string repr_cpp_operatorHeader(const PTabGraphToken & tabGraphToken){
///Save the source of the Operator parser utils
/** @param tabGraphToken : PTabGraphToken to be used
* @param baseFileName : base name of the header file
* @return c++
*/
std::string repr_cpp_operatorSource(const PTabGraphToken & tabGraphToken, const std::string & baseFileName){
......
......@@ -57,7 +57,8 @@ bool PStmt::check(_Callable&& __f, _Args&&... __args) const{
}
///Call a function __f on the statment it self and on its children
/** @param __f : function to be called, must be a 'void f(T & out, const PStmt & inOut, extra args)'
/** @param[out] out : output to be set
* @param __f : function to be called, must be a 'void f(T & out, const PStmt & inOut, extra args)'
* @param __args : extra argument to be passed to the function
*/
template<typename T, typename _Callable, typename... _Args>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment