Browse Source

fixed comments and names of arguments in file.h for consistency

tempestpy_adaptions
Sebastian Junges 8 years ago
parent
commit
0b2a8d1adf
  1. 20
      src/storm/utility/file.h

20
src/storm/utility/file.h

@ -1,12 +1,4 @@
/**
* @file: file.h
* @author: Sebastian Junges
*
* @since October 7, 2014
*/
#ifndef STORM_UTILITY_FILE_H_
#define STORM_UTILITY_FILE_H_
#pragma once
#include <iostream> #include <iostream>
@ -19,7 +11,7 @@ namespace storm {
/*! /*!
* Open the given file for writing. * Open the given file for writing.
* *
* @param filename Path and name of the file to be tested.
* @param filepath Path and name of the file to be written to.
* @param filestream Contains the file handler afterwards. * @param filestream Contains the file handler afterwards.
* @param append If true, the new content is appended instead of clearing the existing content. * @param append If true, the new content is appended instead of clearing the existing content.
*/ */
@ -36,7 +28,7 @@ namespace storm {
/*! /*!
* Open the given file for reading. * Open the given file for reading.
* *
* @param filename Path and name of the file to be tested.
* @param filepath Path and name of the file to be tested.
* @param filestream Contains the file handler afterwards. * @param filestream Contains the file handler afterwards.
*/ */
inline void openFile(std::string const& filepath, std::ifstream& filestream) { inline void openFile(std::string const& filepath, std::ifstream& filestream) {
@ -47,7 +39,7 @@ namespace storm {
/*! /*!
* Close the given file after writing. * Close the given file after writing.
* *
* @param filestream Contains the file handler to close.
* @param stream Contains the file handler to close.
*/ */
inline void closeFile(std::ofstream& stream) { inline void closeFile(std::ofstream& stream) {
stream.close(); stream.close();
@ -56,7 +48,7 @@ namespace storm {
/*! /*!
* Close the given file after reading. * Close the given file after reading.
* *
* @param filestream Contains the file handler to close.
* @param stream Contains the file handler to close.
*/ */
inline void closeFile(std::ifstream& stream) { inline void closeFile(std::ifstream& stream) {
stream.close(); stream.close();
@ -77,5 +69,3 @@ namespace storm {
} }
} }
#endif
Loading…
Cancel
Save