From 5cf5076dd1ca42df7de872e57c1751f94aff1d88 Mon Sep 17 00:00:00 2001 From: Scott R Charlton Date: Wed, 6 Nov 2013 04:05:02 +0000 Subject: [PATCH] updating documentation for C/Fortran routines git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@8177 1feff8c3-07ed-0310-ac33-dd36852eb9cd --- src/IPhreeqc.h | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/src/IPhreeqc.h b/src/IPhreeqc.h index 74607ba2..0505545e 100644 --- a/src/IPhreeqc.h +++ b/src/IPhreeqc.h @@ -243,9 +243,11 @@ extern "C" { IPQ_DLL_EXPORT int GetComponentCount(int id); /** - * Retrieves the currently active SELECTED_OUTPUT user number for use in subsequent calls to GetSelectedOutputXXX routines. - * The initial setting after calling @ref CreateIPhreeqc is @ref IPQ_INVALIDARG. After the first RunXXX method call, the initial setting - * is the lowest defined user number. + * Retrieves the currently active SELECTED_OUTPUT user number for use in subsequent calls to (@ref GetSelectedOutputColumnCount/@ref + * GetSelectedOutputFileName/@ref GetSelectedOutputRowCount/@ref GetSelectedOutputString/@ref GetSelectedOutputStringLine/@ref + * GetSelectedOutputStringLineCount/@ref GetSelectedOutputValue/@ref GetSelectedOutputValue2) routines. + * The initial setting after calling @ref CreateIPhreeqc is @ref IPQ_INVALIDARG. After the first (@ref RunAccumulated/@ref + * RunFile/@ref RunString) method call, the initial setting is the lowest defined user number. * @param id The instance id returned from @ref CreateIPhreeqc. * @return The current active SELECTED_OUTPUT user number. * @see GetNthSelectedOutputUserNumber, GetSelectedOutputCount, SetCurrentSelectedOutputUserNumber @@ -991,7 +993,7 @@ extern "C" { * @retval IPQ_INVALIDCOL The given column is out of range. * @retval IPQ_OUTOFMEMORY Memory could not be allocated. * @retval IPQ_BADINSTANCE The given id is invalid. - * @see GetSelectedOutputFileOn, GetSelectedOutputColumnCount, GetSelectedOutputRowCount, GetSelectedOutputValue2, SetSelectedOutputFileOn + * @see GetCurrentSelectedOutputUserNumber, GetSelectedOutputFileOn, GetSelectedOutputColumnCount, GetSelectedOutputRowCount, GetSelectedOutputValue2, SetCurrentSelectedOutputUserNumber, SetSelectedOutputFileOn * @remarks * Row 0 contains the column headings to the selected_ouput. * @par Examples: @@ -1181,7 +1183,7 @@ Headings * @retval IPQ_INVALIDCOL The given column is out of range. * @retval IPQ_OUTOFMEMORY Memory could not be allocated. * @retval IPQ_BADINSTANCE The given id is invalid. - * @see GetSelectedOutputFileOn, GetSelectedOutputColumnCount, GetSelectedOutputRowCount, GetSelectedOutputValue, SetSelectedOutputFileOn + * @see GetCurrentSelectedOutputUserNumber, GetSelectedOutputFileOn, GetSelectedOutputColumnCount, GetSelectedOutputRowCount, GetSelectedOutputValue, SetCurrentSelectedOutputUserNumber, SetSelectedOutputFileOn * @remarks * Row 0 contains the column headings to the selected_ouput. * @par Examples: @@ -1659,7 +1661,9 @@ Headings /** - * Sets the currently active SELECTED_OUTPUT user number for use in subsequent calls to (GetSelectedOutputColumnCount/GetSelectedOutputFileName/) routines. + * Sets the currently active SELECTED_OUTPUT user number for use in subsequent calls to (@ref GetSelectedOutputColumnCount/@ref + * GetSelectedOutputFileName/@ref GetSelectedOutputRowCount/@ref GetSelectedOutputString/@ref GetSelectedOutputStringLine/@ref + * GetSelectedOutputStringLineCount/@ref GetSelectedOutputValue/@ref GetSelectedOutputValue2) routines. * The initial setting after calling @ref CreateIPhreeqc is IPQ_INVALIDARG. After the first (@ref RunAccumulated/@ref * RunFile/@ref RunString) method call, the initial setting is the lowest defined user number. * @param id The instance id returned from @ref CreateIPhreeqc.