Skip to content
Permalink
Browse files

Fix doxygen

  • Loading branch information
m-kuhn committed Aug 19, 2016
1 parent 30b032c commit bcae877fab132b358e4dbb5ef5e77ec8ea247726
Showing with 93 additions and 22 deletions.
  1. +45 −8 python/core/qgsproject.sip
  2. +3 −6 src/core/qgsproject.cpp
  3. +45 −8 src/core/qgsproject.h
@@ -145,20 +145,57 @@ class QgsProject : QObject
void clearProperties() /Deprecated/;


/* key value mutators
/**
* Write a boolean entry to the project file.
*
* keys would be the familiar QSettings-like '/' delimited entries, implying
* Keys are '/'-delimited entries, implying
* a hierarchy of keys and corresponding values
*
* @note The key string must be valid xml tag names in order to be saved to the file.
* @note available in python bindings as writeEntryBool
*/
//! @note available in python bindings as writeEntryBool
bool writeEntry( const QString & scope, const QString & key, bool value ) /PyName=writeEntryBool/;
//! @note available in python bindings as writeEntryDouble
bool writeEntry( const QString & scope, const QString & key, double value ) /PyName=writeEntryDouble/;
bool writeEntry( const QString & scope, const QString & key, int value );
bool writeEntry( const QString & scope, const QString & key, const QString & value );
bool writeEntry( const QString & scope, const QString & key, const QStringList & value );

/**
* Write a double entry to the project file.
*
* Keys are '/'-delimited entries, implying
* a hierarchy of keys and corresponding values
*
* @note The key string must be valid xml tag names in order to be saved to the file.
* @note available in python bindings as writeEntryDouble
*/
bool writeEntry( const QString& scope, const QString& key, double value ) /PyName=writeEntryDouble/;

/**
* Write an integer entry to the project file.
*
* Keys are '/'-delimited entries, implying
* a hierarchy of keys and corresponding values
*
* @note The key string must be valid xml tag names in order to be saved to the file.
*/
bool writeEntry( const QString& scope, const QString& key, int value );

/**
* Write a string entry to the project file.
*
* Keys are '/'-delimited entries, implying
* a hierarchy of keys and corresponding values
*
* @note The key string must be valid xml tag names in order to be saved to the file.
*/
bool writeEntry( const QString& scope, const QString& key, const QString& value );

/**
* Write a string list entry to the project file.
*
* Keys are '/'-delimited entries, implying
* a hierarchy of keys and corresponding values
*
* @note The key string must be valid xml tag names in order to be saved to the file.
*/
bool writeEntry( const QString& scope, const QString& key, const QStringList& value );

/** Key value accessors
*
@@ -1243,8 +1243,7 @@ bool QgsProject::writeEntry( const QString& scope, QString const& key, bool valu
return addKey_( scope, key, &imp_->properties_, value );
}

bool QgsProject::writeEntry( const QString& scope, const QString& key,
double value )
bool QgsProject::writeEntry( const QString& scope, const QString& key, double value )
{
setDirty( true );

@@ -1258,16 +1257,14 @@ bool QgsProject::writeEntry( const QString& scope, QString const& key, int value
return addKey_( scope, key, &imp_->properties_, value );
}

bool QgsProject::writeEntry( const QString& scope, const QString &key,
const QString& value )
bool QgsProject::writeEntry( const QString& scope, const QString& key, const QString& value )
{
setDirty( true );

return addKey_( scope, key, &imp_->properties_, value );
}

bool QgsProject::writeEntry( const QString& scope, const QString& key,
const QStringList& value )
bool QgsProject::writeEntry( const QString& scope, const QString& key, const QStringList& value )
{
setDirty( true );

@@ -201,20 +201,57 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
Q_DECL_DEPRECATED void clearProperties();


/* key value mutators
/**
* Write a boolean entry to the project file.
*
* keys would be the familiar QSettings-like '/' delimited entries, implying
* Keys are '/'-delimited entries, implying
* a hierarchy of keys and corresponding values
*
* @note The key string must be valid xml tag names in order to be saved to the file.
* @note available in python bindings as writeEntryBool
*/
//! @note available in python bindings as writeEntryBool
bool writeEntry( const QString & scope, const QString & key, bool value );
//! @note available in python bindings as writeEntryDouble
bool writeEntry( const QString & scope, const QString & key, double value );
bool writeEntry( const QString & scope, const QString & key, int value );
bool writeEntry( const QString & scope, const QString & key, const QString & value );
bool writeEntry( const QString & scope, const QString & key, const QStringList & value );

/**
* Write a double entry to the project file.
*
* Keys are '/'-delimited entries, implying
* a hierarchy of keys and corresponding values
*
* @note The key string must be valid xml tag names in order to be saved to the file.
* @note available in python bindings as writeEntryDouble
*/
bool writeEntry( const QString& scope, const QString& key, double value );

/**
* Write an integer entry to the project file.
*
* Keys are '/'-delimited entries, implying
* a hierarchy of keys and corresponding values
*
* @note The key string must be valid xml tag names in order to be saved to the file.
*/
bool writeEntry( const QString& scope, const QString& key, int value );

/**
* Write a string entry to the project file.
*
* Keys are '/'-delimited entries, implying
* a hierarchy of keys and corresponding values
*
* @note The key string must be valid xml tag names in order to be saved to the file.
*/
bool writeEntry( const QString& scope, const QString& key, const QString& value );

/**
* Write a string list entry to the project file.
*
* Keys are '/'-delimited entries, implying
* a hierarchy of keys and corresponding values
*
* @note The key string must be valid xml tag names in order to be saved to the file.
*/
bool writeEntry( const QString& scope, const QString& key, const QStringList& value );

/** Key value accessors
*

0 comments on commit bcae877

Please sign in to comment.
You can’t perform that action at this time.