From: Wolfgang Bangerth Date: Thu, 30 Nov 2017 06:02:06 +0000 (-0700) Subject: Update function documentation. X-Git-Tag: v9.0.0-rc1~708^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F5555%2Fhead;p=dealii.git Update function documentation. --- 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);