Skip to content
Permalink
Browse files

fix multiline comments on out params

  • Loading branch information
3nids committed Dec 18, 2018
1 parent edfb7e1 commit 32e844f9f8703fc7c9f6973da6fe2f77f95e6722
@@ -344,13 +344,10 @@ Searches for the closest segment of the geometry to a given point.
:param pt: specifies the point to find closest segment to
:param segmentPt: storage for the closest point within the geometry
:param vertexAfter: storage for the ID of the vertex at the end of the closest segment
of the geometry, +1 if the point is to the right of the geometry, or 0 for cases where left/right could not
be determined, e.g. point exactly on a line)
false if point is to right of segment)
:param epsilon: epsilon for segment snapping

:return: squared distance to closest segment or negative value on error
leftOf: indicates whether the point lies on the left side of the geometry (-1 if point is to the left
leftOf: indicates whether the point lies on the left side of the geometry (-1 if point is to the left of the geometry, +1 if the point is to the right of the geometry, or 0 for cases where left/right could not be determined, e.g. point exactly on a line) false if point is to right of segment)
%End


@@ -650,10 +650,9 @@ Save the current metadata of this layer as the default metadata
(either as a .qmd file on disk or as a
record in the users style table in their personal qgis.db)

we did not manage to save the default metadata.

:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
resultFlag: a reference to a flag that will be set to false if we did not manage to save the default metadata.

.. versionadded:: 3.0
%End
@@ -688,10 +687,9 @@ record in the users style table in their personal qgis.db)
is a file and load that, if that fails the qgis.db metadata
table will be consulted to see if there is a metadata who's
key matches the URI.
we did not manage to load the default metadata.

:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
resultFlag: a reference to a flag that will be set to false if we did not manage to load the default metadata.

.. versionadded:: 3.0
%End
@@ -752,10 +750,9 @@ Retrieve the default style for this layer if one
exists (either as a .qml file on disk or as a
record in the users style table in their personal qgis.db)

we did not manage to load the default style.

:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
resultFlag: a reference to a flag that will be set to false if we did not manage to load the default style.

.. seealso:: :py:func:`also`
%End
@@ -771,11 +768,10 @@ record in the users style table in their personal qgis.db)
is a file and load that, if that fails the qgis.db styles
table will be consulted to see if there is a style who's
key matches the URI.
we did not manage to load the default style.
:param categories: the style categories to be loaded.

:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
resultFlag: a reference to a flag that will be set to false if we did not manage to load the default style.

.. seealso:: :py:func:`also`
%End
@@ -834,10 +830,9 @@ Save the properties of this layer as the default style
(either as a .qml file on disk or as a
record in the users style table in their personal qgis.db)

we did not manage to save the default style.

:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
resultFlag: a reference to a flag that will be set to false if we did not manage to save the default style.

.. seealso:: :py:func:`loadNamedStyle`
%End
@@ -853,11 +848,10 @@ record in the users style table in their personal qgis.db)
is a file and save to that, if that fails the qgis.db styles
table will be used to create a style entry who's
key matches the URI.
we did not manage to save the default style.
:param categories: the style categories to be saved.

:return: a QString with any status messages
resultFlag: a reference to a flag that will be set to false if
resultFlag: a reference to a flag that will be set to false if we did not manage to save the default style.

.. seealso:: :py:func:`saveDefaultStyle`
%End
@@ -295,14 +295,12 @@ of a sub-expression reflecting the parent property's state.
Attempts to parse an expression into a corresponding property transformer.

:param expression: expression to parse
is used to calculate the input to the property transformer. This will be set to an
empty string if a field reference is the transformer input.
:param fieldName: will be set to a field name which is used to calculate the input
to the property transformer. This will be set to an
empty string if an expression is the transformer input.

:return: corresponding property transformer, or None if expression could not
baseExpression: will be set to the component of the source expression which
baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input.
be parsed to a transformer.
%End

@@ -364,14 +362,12 @@ Constructor for QgsGenericNumericTransformer.
Attempts to parse an expression into a corresponding :py:class:`QgsSizeScaleTransformer`.

:param expression: expression to parse
is used to calculate the input to the property transformer. This will be set to an
empty string if a field reference is the transformer input.
:param fieldName: will be set to a field name which is used to calculate the input
to the property transformer. This will be set to an
empty string if an expression is the transformer input.

:return: corresponding :py:class:`QgsSizeScaleTransformer`, or None if expression could not
baseExpression: will be set to the component of the source expression which
baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input.
be parsed to a size scale transformer.
%End

@@ -513,14 +509,12 @@ Constructor for QgsSizeScaleTransformer.
Attempts to parse an expression into a corresponding QgsSizeScaleTransformer.

:param expression: expression to parse
is used to calculate the input to the property transformer. This will be set to an
empty string if a field reference is the transformer input.
:param fieldName: will be set to a field name which is used to calculate the input
to the property transformer. This will be set to an
empty string if an expression is the transformer input.

:return: corresponding QgsSizeScaleTransformer, or None if expression could not
baseExpression: will be set to the component of the source expression which
baseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input.
be parsed to a size scale transformer.
%End

@@ -1212,17 +1212,23 @@ sub detect_non_method_member{
if ( $1 ~~ @SKIPPED_PARAMS_OUT ) {
$comment_line =~ s/^:param\s+(\w+):(.*)$/$1: $2/;
push @out_params, $comment_line ;
$skipping_param = 2;
}
else {
$skipping_param = 1;
}
$skipping_param = 1;
next;
}
}
if ( $skipping_param == 1 ) {
if ( $skipping_param > 0 ) {
if ( $comment_line =~ m/^(:.*|\.\..*|\s*)$/ ){
$skipping_param = 0;
}
else {
elsif ( $skipping_param == 2 ) {
$comment_line =~ s/^\s+/ /;
$out_params[$#out_params] .= $comment_line;
# exit_with_error('Skipped param (SIP_OUT) should have their doc on a single line');
next;
}
}
write_output("CM2", "$doc_prepend$comment_line\n");

0 comments on commit 32e844f

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