From 3aec5c64849ee925c20735dc71fa64899040c09e Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Wed, 21 Apr 2021 23:50:13 -0400 Subject: [PATCH] tweak docs for logmesg() overload --- doc/src/Developer_utils.rst | 5 ++++- src/utils.h | 8 +++++--- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/src/Developer_utils.rst b/doc/src/Developer_utils.rst index 17b4715dc7..7adaffa67c 100644 --- a/doc/src/Developer_utils.rst +++ b/doc/src/Developer_utils.rst @@ -164,7 +164,10 @@ Argument processing Convenience functions ^^^^^^^^^^^^^^^^^^^^^ -.. doxygenfunction:: logmesg +.. doxygenfunction:: logmesg(LAMMPS *lmp, const S &format, Args&&... args) + :project: progguide + +.. doxygenfunction:: logmesg(LAMMPS *lmp, const std::string &mesg) :project: progguide .. doxygenfunction:: getsyserror diff --git a/src/utils.h b/src/utils.h index 6eed8fd3bc..e0ab413e59 100644 --- a/src/utils.h +++ b/src/utils.h @@ -57,8 +57,7 @@ namespace LAMMPS_NS { * This function simplifies the repetitive task of outputting some * message to both the screen and/or the log file. The template * wrapper with fmtlib format and argument processing allows - * this function to work similar to fmt::print(). - * The specialization overload handles the case of no arguments. + * this function to work similar to ``fmt::print()``. * * \param lmp pointer to LAMMPS class instance * \param format format string of message to be printed @@ -70,7 +69,10 @@ namespace LAMMPS_NS { fmt::make_args_checked(format, args...)); } - /** \overload */ + /** \overload + * + * \param lmp pointer to LAMMPS class instance + * \param mesg string with message to be printed */ void logmesg(LAMMPS *lmp, const std::string &mesg);