From 79dc0e4b59ad3291e74151f2c86d669e178bfe3f Mon Sep 17 00:00:00 2001
From: Nina Dzugasova <dzugasova.nina@gmail.com>
Date: Mon, 26 Nov 2018 13:55:24 +0100
Subject: [PATCH] Fixed FileName documentation.
---
src/TNL/FileName.h | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/src/TNL/FileName.h b/src/TNL/FileName.h
index 601ced0426..9642e570d8 100644
--- a/src/TNL/FileName.h
+++ b/src/TNL/FileName.h
@@ -18,6 +18,9 @@ String getFileExtension( const String fileName );
void removeFileExtension( String& file_name );
+/// \brief Class for creating the full name of a file.
+///
+/// Merges base name, index number and extention to create the full name of a file.
class FileName
{
public:
@@ -42,7 +45,7 @@ class FileName
/// \brief Sets the extension of given file.
///
/// Sets \e extension as suffix of a file name.
- /// @param extension String that specifies extension of file (without dot).
+ /// @param extension A String that specifies extension of file (without dot).
/// Suffix of a file name. E.g. doc, xls, tnl.
void setExtension( const String& extension );
@@ -63,7 +66,7 @@ class FileName
template< typename Coordinates >
void setDistributedSystemNodeId( const Coordinates& nodeId );
- /// Creates appropriate name for given file.
+ /// \brief Creates appropriate name for given file.
///
/// Creates particular file name using \e fileNameBase, \e digitsCount,
/// \e index and \e extension.
--
GitLab