Improved class description docs

This commit is contained in:
Ivan Ivanov 2021-01-12 23:15:12 +02:00
parent f8b468a045
commit a1ffcd5c7d
2 changed files with 4 additions and 4 deletions

View File

@ -14,9 +14,9 @@
class QgsPolymorphicRelation
{
%Docstring
A polymorphic relation consists of the same properties like an ordinary relation except for the referenced layer which is calculated based on one or several fields of the referencing layer.
A polymorphic relation consists of the same properties like a normal relation except for the referenced layer which is calculated based on one or several fields of the referencing layer.
In its most simple form, the referencing layer will just insert the layer name of the referenced layer into this field.
To be more precise, a Polymorphic relation is a set of standard relations having the same referencing layer but having the referenced layer dynamically defined.
To be more precise, a polymorphic relation is a set of normal relations having the same referencing layer but having the referenced layer dynamically defined.
The polymorphic setting of the layer is solved by using an expression which has to match some properties of the the referenced layer like the table name, schema, uri, layer id, ...
.. versionadded:: 3.18

View File

@ -37,9 +37,9 @@ class QgsPolymorphicRelationPrivate;
class QgsExpressionContext;
/**
* A polymorphic relation consists of the same properties like an ordinary relation except for the referenced layer which is calculated based on one or several fields of the referencing layer.
* A polymorphic relation consists of the same properties like a normal relation except for the referenced layer which is calculated based on one or several fields of the referencing layer.
* In its most simple form, the referencing layer will just insert the layer name of the referenced layer into this field.
* To be more precise, a Polymorphic relation is a set of standard relations having the same referencing layer but having the referenced layer dynamically defined.
* To be more precise, a polymorphic relation is a set of normal relations having the same referencing layer but having the referenced layer dynamically defined.
* The polymorphic setting of the layer is solved by using an expression which has to match some properties of the the referenced layer like the table name, schema, uri, layer id, ...
* \ingroup core
* \class QgsPolymorphicRelation