summaryrefslogtreecommitdiff
path: root/libvaladoc
diff options
context:
space:
mode:
authorRico Tzschichholz <ricotz@ubuntu.com>2019-10-18 08:33:43 +0200
committerRico Tzschichholz <ricotz@ubuntu.com>2019-10-18 15:42:20 +0200
commit513faa82a511372a25f508ead71722a21dd11cc5 (patch)
tree02cbb793858fb57f3aef12becd7f8f037bd0cfb8 /libvaladoc
parentf3ce99e3448f00992b828265f2a776c8938c4423 (diff)
downloadvala-513faa82a511372a25f508ead71722a21dd11cc5.tar.gz
valadoc: Rename FormalParameter to Parameter
Diffstat (limited to 'libvaladoc')
-rw-r--r--libvaladoc/Makefile.am2
-rw-r--r--libvaladoc/api/parameter.vala (renamed from libvaladoc/api/formalparameter.vala)8
-rw-r--r--libvaladoc/api/visitor.vala6
-rw-r--r--libvaladoc/documentation/importerhelper.vala8
-rw-r--r--libvaladoc/gtkdocrenderer.vala8
-rw-r--r--libvaladoc/importer/girdocumentationimporter.vala12
-rw-r--r--libvaladoc/taglets/tagletparam.vala4
7 files changed, 24 insertions, 24 deletions
diff --git a/libvaladoc/Makefile.am b/libvaladoc/Makefile.am
index 8a3924b54..b3cf7e5a3 100644
--- a/libvaladoc/Makefile.am
+++ b/libvaladoc/Makefile.am
@@ -67,7 +67,6 @@ libvaladoc_la_VALASOURCES = \
api/errorcode.vala \
api/errordomain.vala \
api/field.vala \
- api/formalparameter.vala \
api/interface.vala \
api/item.vala \
api/method.vala \
@@ -76,6 +75,7 @@ libvaladoc_la_VALASOURCES = \
api/nodetype.vala \
api/ownership.vala \
api/package.vala \
+ api/parameter.vala \
api/pointer.vala \
api/property.vala \
api/propertyaccessor.vala \
diff --git a/libvaladoc/api/formalparameter.vala b/libvaladoc/api/parameter.vala
index 0014f120b..8ae6b133a 100644
--- a/libvaladoc/api/formalparameter.vala
+++ b/libvaladoc/api/parameter.vala
@@ -1,4 +1,4 @@
-/* formalparameter.vala
+/* parameter.vala
*
* Copyright (C) 2008-2011 Florian Brosch
*
@@ -24,9 +24,9 @@
using Valadoc.Content;
/**
- * Represents a formal parameter in method, signal and delegate signatures.
+ * Represents a parameter in method, signal and delegate signatures.
*/
-public class Valadoc.Api.FormalParameter : Symbol {
+public class Valadoc.Api.Parameter : Symbol {
public Content.Run default_value {
get;
set;
@@ -58,7 +58,7 @@ public class Valadoc.Api.FormalParameter : Symbol {
private Vala.ParameterDirection type;
- public FormalParameter (Node parent, SourceFile file, string? name, Vala.SymbolAccessibility accessibility, Vala.ParameterDirection type, bool ellipsis, Vala.Parameter data) {
+ public Parameter (Node parent, SourceFile file, string? name, Vala.SymbolAccessibility accessibility, Vala.ParameterDirection type, bool ellipsis, Vala.Parameter data) {
base (parent, file, name, accessibility, null, data);
assert ((name == null && ellipsis) || (name != null && !ellipsis));
diff --git a/libvaladoc/api/visitor.vala b/libvaladoc/api/visitor.vala
index bf66a456b..71155bd96 100644
--- a/libvaladoc/api/visitor.vala
+++ b/libvaladoc/api/visitor.vala
@@ -130,11 +130,11 @@ public abstract class Valadoc.Api.Visitor : GLib.Object {
}
/**
- * Visit operation called for formal parameters.
+ * Visit operation called for parameters.
*
- * @param item a formal parameter
+ * @param item a parameter
*/
- public virtual void visit_formal_parameter (FormalParameter item) {
+ public virtual void visit_formal_parameter (Parameter item) {
}
/**
diff --git a/libvaladoc/documentation/importerhelper.vala b/libvaladoc/documentation/importerhelper.vala
index 952db70e5..98100d308 100644
--- a/libvaladoc/documentation/importerhelper.vala
+++ b/libvaladoc/documentation/importerhelper.vala
@@ -36,15 +36,15 @@ namespace Valadoc.ImporterHelper {
is_return_type_len = false;
param_array_name = null;
- Api.FormalParameter? param = null; // type parameter or formal parameter
+ Api.Parameter? param = null; // type parameter or formal parameter
foreach (Api.Node node in element.get_children_by_type (Api.NodeType.FORMAL_PARAMETER, false)) {
if (node.name == parts[0]) {
- param = node as Api.FormalParameter;
+ param = node as Api.Parameter;
break;
}
- if (((Api.FormalParameter) node).implicit_array_length_cparameter_name == parts[0]) {
- param_array_name = ((Api.FormalParameter) node).name;
+ if (((Api.Parameter) node).implicit_array_length_cparameter_name == parts[0]) {
+ param_array_name = ((Api.Parameter) node).name;
break;
}
}
diff --git a/libvaladoc/gtkdocrenderer.vala b/libvaladoc/gtkdocrenderer.vala
index f1197eda1..e76704e85 100644
--- a/libvaladoc/gtkdocrenderer.vala
+++ b/libvaladoc/gtkdocrenderer.vala
@@ -31,8 +31,8 @@ public class Valadoc.GtkdocRenderer : ContentRenderer {
private string? get_cname (Api.Item item) {
if (item is Api.Method) {
return ((Api.Method)item).get_cname ();
- } else if (item is Api.FormalParameter) {
- return ((Api.FormalParameter)item).name;
+ } else if (item is Api.Parameter) {
+ return ((Api.Parameter)item).name;
} else if (item is Api.Constant) {
return ((Api.Constant)item).get_cname ();
} else if (item is Api.Property) {
@@ -68,9 +68,9 @@ public class Valadoc.GtkdocRenderer : ContentRenderer {
writer.start_tag ("function")
.text (((Api.Method)item).get_cname ())
.end_tag ("function");
- } else if (item is Api.FormalParameter) {
+ } else if (item is Api.Parameter) {
writer.start_tag ("parameter").
- text (((Api.FormalParameter)item).name ?? "...")
+ text (((Api.Parameter)item).name ?? "...")
.end_tag ("parameter");
} else if (item is Api.Constant) {
writer.start_tag ("constant").text (((Api.Constant)item)
diff --git a/libvaladoc/importer/girdocumentationimporter.vala b/libvaladoc/importer/girdocumentationimporter.vala
index 5d72f4414..57c87bb7d 100644
--- a/libvaladoc/importer/girdocumentationimporter.vala
+++ b/libvaladoc/importer/girdocumentationimporter.vala
@@ -79,11 +79,11 @@ public class Valadoc.Importer.GirDocumentationImporter : DocumentationImporter {
file = null;
}
- private Api.FormalParameter? find_parameter (Api.Node node, string name) {
+ private Api.Parameter? find_parameter (Api.Node node, string name) {
Vala.List<Api.Node> parameters = node.get_children_by_type (Api.NodeType.FORMAL_PARAMETER, false);
foreach (Api.Node param in parameters) {
- if (((Api.FormalParameter) param).name == name) {
- return (Api.FormalParameter) param;
+ if (((Api.Parameter) param).name == name) {
+ return (Api.Parameter) param;
}
}
@@ -117,7 +117,7 @@ public class Valadoc.Importer.GirDocumentationImporter : DocumentationImporter {
if (param_names != null) {
foreach (ImplicitParameterPos pos in destroy_notifies) {
- Api.FormalParameter? param = find_parameter (node, param_names[pos.parameter]);
+ Api.Parameter? param = find_parameter (node, param_names[pos.parameter]);
if (param == null) {
continue ;
}
@@ -127,7 +127,7 @@ public class Valadoc.Importer.GirDocumentationImporter : DocumentationImporter {
}
foreach (ImplicitParameterPos pos in closures) {
- Api.FormalParameter? param = find_parameter (node, param_names[pos.parameter]);
+ Api.Parameter? param = find_parameter (node, param_names[pos.parameter]);
if (param == null) {
continue ;
}
@@ -137,7 +137,7 @@ public class Valadoc.Importer.GirDocumentationImporter : DocumentationImporter {
}
foreach (ImplicitParameterPos pos in array_lengths) {
- Api.FormalParameter? param = find_parameter (node, param_names[pos.parameter]);
+ Api.Parameter? param = find_parameter (node, param_names[pos.parameter]);
if (param == null) {
continue ;
}
diff --git a/libvaladoc/taglets/tagletparam.vala b/libvaladoc/taglets/tagletparam.vala
index 274669100..963f96dd0 100644
--- a/libvaladoc/taglets/tagletparam.vala
+++ b/libvaladoc/taglets/tagletparam.vala
@@ -69,7 +69,7 @@ public class Valadoc.Taglets.Param : BlockContent, Taglet, Block {
} else if (parameter_name == "...") {
Vala.List<Api.Node> params = container.get_children_by_type (Api.NodeType.FORMAL_PARAMETER, false);
foreach (Api.Node param in params) {
- if (((Api.FormalParameter) param).ellipsis) {
+ if (((Api.Parameter) param).ellipsis) {
this.parameter = (Api.Symbol) param;
this.position = (has_instance)? params.size : params.size - 1;
break;
@@ -88,7 +88,7 @@ public class Valadoc.Taglets.Param : BlockContent, Taglet, Block {
break;
}
- Api.FormalParameter formalparam = param as Api.FormalParameter;
+ Api.Parameter formalparam = param as Api.Parameter;
if (formalparam != null && (formalparam.implicit_array_length_cparameter_name == parameter_name
|| formalparam.implicit_closure_cparameter_name == parameter_name
|| formalparam.implicit_destroy_cparameter_name == parameter_name))