Skip to content
Snippets Groups Projects
Commit 79dc0e4b authored by Nina Džugasová's avatar Nina Džugasová Committed by Tomáš Oberhuber
Browse files

Fixed FileName documentation.

parent 3d8b8d30
No related branches found
No related tags found
1 merge request!15Nina
......@@ -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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment