Skip to content

Commit f55c524

Browse files
committed
[Doxygen] fix multi-function definition in doxygen.
This will solve the problem, but I don't think I have time to update every doc. Future work here. I'm not showing api doc in the website anyway. This is just a test.
1 parent c8f94a1 commit f55c524

File tree

3 files changed

+17
-27
lines changed

3 files changed

+17
-27
lines changed

include/libyt.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ int yt_set_UserParameterUlong(const char* key, const int n, const unsigned long*
3838
int yt_set_UserParameterFloat(const char* key, const int n, const float* input);
3939
int yt_set_UserParameterDouble(const char* key, const int n, const double* input);
4040
int yt_set_UserParameterString(const char* key, const char* input);
41-
int yt_commit();
41+
int yt_commit(); /*!< \ingroup api_yt_commit */
4242
int yt_free();
4343
int yt_run_FunctionArguments(const char* function_name, int argc, ...);
4444
int yt_run_Function(const char* function_name);

src/py_add_dict.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ int AddStringToDict(PyObject* dict, const char* key, const char* string) {
161161
}
162162

163163
// explicit template instantiation
164-
/*!< \cond */
164+
/** @cond */
165165
template int AddScalarToDict<float>(PyObject* dict, const char* key, const float value);
166166
template int AddScalarToDict<double>(PyObject* dict, const char* key, const double value);
167167
template int AddScalarToDict<int>(PyObject* dict, const char* key, const int value);
@@ -186,6 +186,6 @@ template int AddVectorNToDict<unsigned int>(PyObject* dict, const char* key,
186186
const int len, const unsigned int* vector);
187187
template int AddVectorNToDict<unsigned long>(PyObject* dict, const char* key,
188188
const int len, const unsigned long* vector);
189-
/*!< \endcond */
189+
/** @endcond */
190190
} // namespace python_controller
191191
#endif // #ifndef USE_PYBIND11

src/yt_commit.cpp

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,20 @@
44
#include "logging.h"
55
#include "timer.h"
66

7-
//-------------------------------------------------------------------------------------------------------
8-
// Function : yt_commit
9-
// Description : Add local grids, append field list and particle list info to the libyt
10-
// Python module.
11-
//
12-
// Note : 1. Must call yt_get_FieldsPtr (if num_fields>0), yt_get_ParticlesPtr (if
13-
// num_par_types>0),
14-
// yt_get_GridsPtr, which gets data info from user.
15-
// 2. Check the local grids, field list, and particle list.
16-
// 3. Append field_list info and particle_list info to
17-
// libyt.param_yt['field_list'] and
18-
// libyt.param_yt['particle_list'].
19-
// 4. Gather hierarchy in different rank, and check hierarchy in
20-
// check_hierarchy(), excluding
21-
// particles.
22-
// 5. If there is particle, we gather different particle type separately.
23-
// 6. Pass the grids and hierarchy to YT in function append_grid().
24-
// 7. We assume that one grid contains all the fields belong to that grid.
25-
// 8. Free LibytProcessControl::Get().param_yt_.grids_local, after we have
26-
// passed all grid info and data in.
27-
// 9. TODO: this can be more memory efficient when gathering hierarchy.
28-
//
29-
// Return : YT_SUCCESS or YT_FAIL
30-
//-------------------------------------------------------------------------------------------------------
7+
/**
8+
* \defgroup api_yt_commit libyt API: yt_commit
9+
* \fn int yt_commit()
10+
* \brief
11+
* Add local grids, append field list and particle list info to the libyt Python module.
12+
* \details
13+
* 1. Must call \ref yt_get_FieldsPtr (if num_fields>0),
14+
* \ref yt_get_ParticlesPtr (if num_par_types>0), and \ref yt_get_GridsPtr.
15+
* 2. Call DataStructureAmr to bind info, bind hierarchy, and bind local data to Python.
16+
*
17+
* \version 0.1.0
18+
*
19+
* @return \ref YT_SUCCESS or \ref YT_FAIL
20+
*/
3121
int yt_commit() {
3222
SET_TIMER(__PRETTY_FUNCTION__);
3323

0 commit comments

Comments
 (0)