*******************************************************************************/
-/*! \file ConfigGenerator.h
-\brief Generating default config files, css stylesheet etc
+/*!
+ \file ConfigGenerator.h
+ \brief Generating default config files, css stylesheet etc
-\author Bartosz Szatkowski <bulislaw@linux.com>
+ \author Bartosz Szatkowski <bulislaw@linux.com>
*/
#ifndef CONFIGGENERATOR_H
#include <QString>
#include <QDebug>
-/*! ConfigGenerator generates configuration files (with default values),
-if given file doesn't exist.
+/*!
+ ConfigGenerator generates configuration files (with default values),
+ if a given file doesn't exist.
*/
class ConfigGenerator {
public:
- /*! Generates default css stylesheet for xslt transformations
+ /*!
+ Generates default css stylesheet for xslt transformations
\param file file to be generated
\return if file was generated - returns true; if file alredy exists
- returns true; if file doesn't exist but cannot be generated returns false
+ returns true; if file doesn't exist but cannot be generated returns false
*/
bool generateCss(QString file);
-
/*! Generates default configuration files
\param file file to be generated
- \return if file was generated - returns true; if file alredy exists
- returns true; if file doesn't exist but cannot be generated returns false
+ \return if file was generated - returns true; if file already exists
+ returns true; if file doesn't exist but cannot be generated returns false
*/
bool generateDefaultConfig(QString file);