Skip to content

Commit 9a79181

Browse files
committed
Docstring for constructor
1 parent 00562a3 commit 9a79181

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

core/src/include/Xios.hpp

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,13 @@ class Xios : public Configured<Xios> {
4141
//! Prevent copying
4242
Xios(const Xios&) = delete;
4343

44-
/*
44+
/*!
4545
* Define Xios handler Singleton
4646
*
4747
* NOTE: The arguments will only be used the first time this is called.
48+
*
49+
* @param contextId identifier string for the XIOS context
50+
* @param calendarType calendar type used by XIOS
4851
*/
4952
inline static Xios& getInstance(
5053
const std::string contextId = "nextSIM-DG", const std::string calendarType = "Gregorian")

0 commit comments

Comments
 (0)