diff --git a/doc/modules.dox b/doc/modules.dox new file mode 100644 index 0000000..e69de29 diff --git a/doc/modules_filemanagement.dox b/doc/modules_filemanagement.dox new file mode 100644 index 0000000..06931aa --- /dev/null +++ b/doc/modules_filemanagement.dox @@ -0,0 +1,19 @@ +/** + +@defgroup FileManagement File Management + + + + + + +@addtogroup FileManagement +@{ +@fn int ENwriteline (char *line) +@fn int ENreport () +@fn int ENresetreport () +@fn int ENsetreport (char *reportFormat) +@fn int ENopen (char *inpFile, char *rptFile, char *binOutFile) +@fn int ENsaveinpfile (char *filename) +@} +*/ \ No newline at end of file diff --git a/doc/modules_hydraulicfunctions.dox b/doc/modules_hydraulicfunctions.dox new file mode 100644 index 0000000..a6abb82 --- /dev/null +++ b/doc/modules_hydraulicfunctions.dox @@ -0,0 +1,42 @@ +/** + +@defgroup HydraulicFunctions Hydraulic Analysis + +~~~~~~~~~~~~~~~{.c} +int errcode; +long t, tstep; + +errcode = ENopenH(); +if (!errcode) +{ +errcode = ENinitH(EN_SAVE); +if (!errcode) do +{ +tstep = 0; +ERRCODE(ENrunH(&t)); +ERRCODE(ENnextH(&tstep)); +} +while (tstep > 0); +} + +ENcloseH(); +~~~~~~~~~~~~~~~ + + + +@addtogroup HydraulicFunctions +@{ + +@fn int ENsolveH() +@fn int ENsaveH() +@fn int ENopenH() +@fn int ENinitH(int initFlag) +@fn int ENrunH(long *currentTime) +@fn int ENnextH(long *tStep) +@fn int ENcloseH() +@fn int ENsavehydfile(char *filename) +@fn int ENusehydfile(char *filename) +@fn int ENgetstatistic(int code, EN_API_FLOAT_TYPE* value) + +@} +*/ diff --git a/doc/modules_networkinfo.dox b/doc/modules_networkinfo.dox new file mode 100644 index 0000000..5c0bdd6 --- /dev/null +++ b/doc/modules_networkinfo.dox @@ -0,0 +1,16 @@ +/** + +@defgroup NetworkInfo Network Info + + +@addtogroup NetworkInfo +@{ +@fn int ENgetcount (int code, int *count) +@fn int ENgetnodeindex (char *id, int *index) +@fn int ENgetnodeid (int index, char *id) +@fn int ENgetnodetype (int index, int *code) +@fn int ENgetnodevalue (int index, int code, EN_API_FLOAT_TYPE *value) +@fn int ENgetcoord (int index, EN_API_FLOAT_TYPE *x, EN_API_FLOAT_TYPE *y) +@fn int ENsetcoord (int index, EN_API_FLOAT_TYPE x, EN_API_FLOAT_TYPE y) +@} +*/ \ No newline at end of file diff --git a/doc/modules_patterns.dox b/doc/modules_patterns.dox new file mode 100644 index 0000000..996bf22 --- /dev/null +++ b/doc/modules_patterns.dox @@ -0,0 +1,14 @@ +/** + +@defgroup Patterns + + +@addtogroup Patterns +@{ +@fn int ENgetpatternindex (char *id, int *index) +@fn int ENgetpatternid (int index, char *id) +@fn int ENgetpatternlen (int index, int *len) +@fn int ENgetpatternvalue (int index, int period, EN_API_FLOAT_TYPE *value) +@fn int ENgetaveragepatternvalue (int index, EN_API_FLOAT_TYPE *value) +@} +*/ diff --git a/doc/modules_qualityfunctions.dox b/doc/modules_qualityfunctions.dox new file mode 100644 index 0000000..d4a9087 --- /dev/null +++ b/doc/modules_qualityfunctions.dox @@ -0,0 +1,17 @@ +/** + +@defgroup QualityFunctions Water Quality Functions + + + +@addtogroup QualityFunctions +@{ +@fn int ENsolveQ () +@fn int ENopenQ () +@fn int ENinitQ (int saveFlag) +@fn int ENrunQ (long *currentTime) +@fn int ENnextQ (long *tStep) +@fn int ENstepQ (long *timeLeft) +@fn int ENcloseQ () +@} +*/ \ No newline at end of file diff --git a/doc/modules_toolkitoptions.dox b/doc/modules_toolkitoptions.dox new file mode 100644 index 0000000..e5e798f --- /dev/null +++ b/doc/modules_toolkitoptions.dox @@ -0,0 +1,14 @@ +/** + +@defgroup ToolkitOptions Toolkit Options + + +@addtogroup ToolkitOptions +@{ +@fn int ENgetoption (int code, EN_API_FLOAT_TYPE *value) +@fn int ENgettimeparam (int code, long *value) +@fn int ENgetflowunits (int *code) +@fn int ENgetqualtype (int *qualcode, int *tracenode) +@fn int ENgeterror (int errcode, char *errmsg, int maxLen) +@} +*/ \ No newline at end of file