JIANG/EPANET
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

clarifying documentation

Browse Source
This commit is contained in:
Sam Hatchett
2023-09-13 09:18:08 -04:00
parent d0ab568a5d
commit 8b28307ecd
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/epanet2_2.h
View File

@@ -1644,7 +1644,7 @@ typedef struct Project *EN_Project;
@brief Gets the enabled status of a simple control. @brief Gets the enabled status of a simple control.
@param ph an EPANET project handle. @param ph an EPANET project handle.
@param index the control's index (starting from 1). @param index the control's index (starting from 1).
@param out_enabled the control will be either enabled or disabled. @param out_enabled the control will be either EN_TRUE=enabled or EN_FALSE=disabled.
@return an error code. @return an error code.
*/ */
int DLLEXPORT EN_getcontrolenabled(EN_Project ph, int index, int *out_enabled); int DLLEXPORT EN_getcontrolenabled(EN_Project ph, int index, int *out_enabled);
@@ -1653,7 +1653,7 @@ typedef struct Project *EN_Project;
@brief Sets the enabled status of a simple control. @brief Sets the enabled status of a simple control.
@param ph an EPANET project handle. @param ph an EPANET project handle.
@param index the control's index (starting from 1). @param index the control's index (starting from 1).
@param enabled set the control to either enabled or disabled. @param enabled set the control to either EN_TRUE=enabled or EN_FALSE=disabled.
@return an error code. @return an error code.
*/ */
int DLLEXPORT EN_setcontrolenabled(EN_Project ph, int index, int enabled); int DLLEXPORT EN_setcontrolenabled(EN_Project ph, int index, int enabled);
@@ -1845,7 +1845,7 @@ typedef struct Project *EN_Project;
@brief Gets the enabled status of a rule-based control. @brief Gets the enabled status of a rule-based control.
@param ph an EPANET project handle. @param ph an EPANET project handle.
@param index the rule's index (starting from 1). @param index the rule's index (starting from 1).
@param out_enabled the rule will be either enabled or disabled. @param out_enabled the rule will be either EN_TRUE=enabled or EN_FALSE=disabled.
@return an error code. @return an error code.
*/ */
int DLLEXPORT EN_getruleenabled(EN_Project ph, int index, int *out_enabled); int DLLEXPORT EN_getruleenabled(EN_Project ph, int index, int *out_enabled);
@@ -1854,7 +1854,7 @@ typedef struct Project *EN_Project;
@brief Sets the enabled status of a rule-based control. @brief Sets the enabled status of a rule-based control.
@param ph an EPANET project handle. @param ph an EPANET project handle.
@param index the rule's index (starting from 1). @param index the rule's index (starting from 1).
@param enabled set the rule to either enabled or disabled. @param enabled set the rule to either EN_TRUE=enabled or EN_FALSE=disabled.
@return an error code. @return an error code.
*/ */
int DLLEXPORT EN_setruleenabled(EN_Project ph, int index, int enabled); int DLLEXPORT EN_setruleenabled(EN_Project ph, int index, int enabled);