From bda3849942b7987d7d74e3b495c60aeaa8674a73 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Wed, 29 Nov 2017 23:02:06 -0700 Subject: [PATCH] Update function documentation. --- include/deal.II/base/job_identifier.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/include/deal.II/base/job_identifier.h b/include/deal.II/base/job_identifier.h index 7b15abfb22..4cf80a4841 100644 --- a/include/deal.II/base/job_identifier.h +++ b/include/deal.II/base/job_identifier.h @@ -49,10 +49,11 @@ public: static const char *program_id(); /** - * Obtain the base name of the file currently being compiled. That is, if - * the file is mypath/file.cc return just file. Typically, - * this can be called from a program with the argument __FILE__ and - * is used in the deal.II test suite. + * Obtain the base name of the filename passed as argument. That is, + * if the file is mypath/file.cc return just + * file. For example, this function can be called from a + * user program with argument __FILE__ to create an + * identifier for the program being run. */ static std::string base_name(const char *filename); -- 2.39.5