docstrings etc.

qgis · Aug 7, 2018 · e8e48abae2b799c42ed71aa230581f5b5d7238ac · e8e48ab
1 parent 283b1b4
commit e8e48abae2b799c42ed71aa230581f5b5d7238ac
Unified Split

Showing with 14 additions and 7 deletions.

+1 −0 src/core/qgsproject.cpp

+6 −5 src/core/qgsproject.h

+5 −1 src/core/qgsreadwritecontext.h

+1 −0 src/core/qgsrelation.h

+1 −1 src/core/qgstranslationcontext.h
diff --git a/src/core/qgsproject.cpp b/src/core/qgsproject.cpp
@@ -62,6 +62,7 @@
 #include <QDir>
 #include <QUrl>
 
+
 #ifdef _MSC_VER
 #include <sys/utime.h>
 #else

diff --git a/src/core/qgsproject.h b/src/core/qgsproject.h
@@ -968,7 +968,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
 
     /**
      * Triggers the collection strings of .qgs to be included in ts file and calls writeTsFile()
-     * \since QGIS 3.2
+     * \since QGIS 3.4
      */
     void generateTsFile( const QString &locale );
 
@@ -980,6 +980,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
      * \param sourceText is the identifier of this text
      * \param disambiguation it's the disambiguation
      * \param n if -1 uses the appropriate form
+     * \since QGIS 3.4
      */
     QString translate( const QString &context, const QString &sourceText, const char *disambiguation = nullptr, int n = -1 ) const override;
 
@@ -1298,21 +1299,21 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
     void setPresetHomePath( const QString &path );
 
     /**
-     * Registers the translatable containers into the tranlationContext
+     * Registers the translatable containers into the tranlation context
      * this is a rekursive function to get all the child containers
-     * \since QGIS 3.2
      *
      * \param translationContext where the objects will be registered
      * \param parent parent-container containing list of children
+     * \since QGIS 3.4
     */
     void registerTranslatableContainers( QgsTranslationContext *translationContext, QgsAttributeEditorContainer *parent, const QString &layerId );
 
     /**
-     * Registers the translatable objects into the tranlationContext
+     * Registers the translatable objects into the tranlation context
      * so there can be created a ts file these values
-     * \since QGIS 3.2
      *
      * \param translationContext where the objects will be registered
+     * \since QGIS 3.4
     */
     void registerTranslatableObjects( QgsTranslationContext *translationContext );
 

diff --git a/src/core/qgsreadwritecontext.h b/src/core/qgsreadwritecontext.h
@@ -102,10 +102,14 @@ class CORE_EXPORT QgsReadWriteContext
 
     /**
      * Returns the project translator
-     * \since QGIS 3.2
+     * \since QGIS 3.4
      */
     const QgsProjectTranslator *projectTranslator( ) const { return mProjectTranslator; }
 
+    /**
+     * Sets the project translator
+     * \since QGIS 3.4
+     */
     void setProjectTranslator( QgsProjectTranslator *projectTranslator );
 
   private:

diff --git a/src/core/qgsrelation.h b/src/core/qgsrelation.h
@@ -98,6 +98,7 @@ class CORE_EXPORT QgsRelation
      * Creates a relation from an XML structure. Used for reading .qgs projects.
      *
      * \param node The dom node containing the relation information
+     * \param context to pass project translator
      *
      * \returns A relation
      */

diff --git a/src/core/qgstranslationcontext.h b/src/core/qgstranslationcontext.h
@@ -27,7 +27,7 @@ class QgsProject;
  * \class QgsTranslationContext
  * \brief used for the collecting of strings of .qgs to be translated and writing of ts file
  *
- * \since QGIS 3.2
+ * \since QGIS 3.4
  */
 
 class CORE_EXPORT QgsTranslationContext