this.context = null;
}
- private void write_doc (string? comment) {
+ private void write_doc (string? comment, Comment? symbol = null) {
if (comment != null) {
write_indent ();
- buffer.append ("<doc xml:whitespace=\"preserve\">");
+ if (symbol != null) {
+ var filename = symbol.source_reference.file.get_relative_filename();
+ var line = symbol.source_reference.begin.line;
+ var column = symbol.source_reference.begin.column;
+
+ buffer.append_printf ("<doc xml:space=\"preserve\" filename=\"%s\" line=\"%d\" column=\"%d\">", filename, line, column);
+ } else {
+ buffer.append ("<doc xml:space=\"preserve\">");
+ }
buffer.append (comment);
buffer.append ("</doc>\n");
}
buffer.append_printf (">\n");
indent++;
- write_doc (get_class_comment (cl));
+ write_doc (get_class_comment (cl), cl.comment);
// write implemented interfaces
foreach (DataType base_type in cl.get_base_types ()) {
buffer.append_printf (">\n");
indent++;
- write_doc (get_class_comment (cl));
+ write_doc (get_class_comment (cl), cl.comment);
hierarchy.insert (0, cl);
cl.accept_children (this);
buffer.append_printf (">\n");
indent++;
- write_doc (get_struct_comment (st));
+ write_doc (get_struct_comment (st), st.comment);
hierarchy.insert (0, st);
st.accept_children (this);
buffer.append_printf (">\n");
indent++;
- write_doc (get_interface_comment (iface));
+ write_doc (get_interface_comment (iface), iface.comment);
// write prerequisites
if (iface.get_prerequisites ().size > 0) {
buffer.append_printf (">\n");
indent++;
- write_doc (get_enum_comment (en));
+ write_doc (get_enum_comment (en), en.comment);
enum_value = 0;
hierarchy.insert (0, en);
buffer.append_printf (">\n");
indent++;
- write_doc (comment);
+ write_doc (comment, ev.comment);
indent--;
write_indent ();
buffer.append_printf (">\n");
indent++;
- write_doc (get_error_domain_comment (edomain));
+ write_doc (get_error_domain_comment (edomain), edomain.comment);
enum_value = 0;
hierarchy.insert (0, edomain);
buffer.append_printf (">\n");
indent++;
- write_doc (comment);
+ write_doc (comment, ecode.comment);
indent--;
write_indent ();
buffer.append_printf (">\n");
indent++;
- write_doc (get_constant_comment (c));
+ write_doc (get_constant_comment (c), c.comment);
write_type (initializer.value_type);
buffer.append_printf (">\n");
indent++;
- write_doc (get_field_comment (f));
+ write_doc (get_field_comment (f), f.comment);
write_type (f.variable_type);
private void write_implicit_params (DataType? type, ref int index, bool has_array_length, string? name, ParameterDirection direction) {
if (type is ArrayType && has_array_length) {
for (var i = 0; i < ((ArrayType) type).rank; i++) {
- write_param_or_return (((ArrayType) type).length_type, "parameter", ref index, has_array_length, "%s_length%i".printf (name, i + 1), null, direction);
+ write_param_or_return (((ArrayType) type).length_type, "parameter", ref index, has_array_length, "%s_length%i".printf (name, i + 1), null, null, direction);
}
} else if (type is DelegateType) {
var deleg_type = (DelegateType) type;
if (deleg_type.delegate_symbol.has_target) {
var data_type = new PointerType (new VoidType ());
- write_param_or_return (data_type, "parameter", ref index, false, "%s_target".printf (name), null, direction);
+ write_param_or_return (data_type, "parameter", ref index, false, "%s_target".printf (name), null, null, direction);
if (deleg_type.is_disposable ()) {
var notify_type = new DelegateType (context.root.scope.lookup ("GLib").scope.lookup ("DestroyNotify") as Delegate);
- write_param_or_return (notify_type, "parameter", ref index, false, "%s_target_destroy_notify".printf (name), null, direction);
+ write_param_or_return (notify_type, "parameter", ref index, false, "%s_target_destroy_notify".printf (name), null, null, direction);
}
}
}
buffer.append_printf ("</%s>\n", tag_type);
}
- private void write_params_and_return (string tag_name, List<Parameter> params, List<TypeParameter>? type_params, DataType? return_type, bool return_array_length, string? return_comment = null, bool constructor = false, Parameter? instance_param = null, bool user_data = false) {
+ private void write_params_and_return (
Callable symbol, string tag_name, List<Parameter> params, List<TypeParameter>? type_params, DataType? return_type, bool return_array_length, string? return_comment = null, bool constructor = false, Parameter? instance_param = null, bool user_data = false) {
int last_index = 0;
bool ret_is_struct = return_type != null && return_type.is_real_non_null_struct_type ();
}
if (return_type != null && !ret_is_struct) {
- write_param_or_return (return_type, "return-value", ref last_index, return_array_length, null, return_comment, ParameterDirection.IN, constructor);
+ write_param_or_return (return_type, "return-value", ref last_index, return_array_length, null, symbol.comment, return_comment, ParameterDirection.IN, constructor);
} else if (ret_is_struct) {
- write_param_or_return (new VoidType (), "return-value", ref last_index, false, null, return_comment, ParameterDirection.IN);
+ write_param_or_return (new VoidType (), "return-value", ref last_index, false, null, symbol.comment, return_comment, ParameterDirection.IN);
}
if (params.size != 0 || (type_params != null && type_params.size > 0) || instance_param != null || (return_type is ArrayType && return_array_length) || (return_type is DelegateType) || ret_is_struct) {
if (constructor && ret_is_struct) {
// struct constructor has a caller-allocates / out-parameter as instance
- write_param_or_return (return_type, "instance-parameter", ref index, false, "self", return_comment, ParameterDirection.OUT, constructor, true);
+ write_param_or_return (return_type, "instance-parameter", ref index, false, "self", symbol.comment, return_comment, ParameterDirection.OUT, constructor, true);
}
if (type_params != null) {
}
foreach (Parameter param in params) {
- write_param_or_return (param.variable_type, "parameter", ref index, get_ccode_array_length (param), get_ccode_name (param), get_parameter_comment (param), param.direction, false, false, param.ellipsis || param.params_array);
+ write_param_or_return (param.variable_type, "parameter", ref index, get_ccode_array_length (param), get_ccode_name (param), param.parent_symbol.comment, get_parameter_comment (param), param.direction, false, false, param.ellipsis || param.params_array);
write_implicit_params (param.variable_type, ref index, get_ccode_array_length (param), get_ccode_name (param), param.direction);
}
if (!constructor && ret_is_struct) {
// struct returns are converted to parameters
- write_param_or_return (return_type, "parameter", ref index, false, "result", return_comment, ParameterDirection.OUT, constructor, true);
+ write_param_or_return (return_type, "parameter", ref index, false, "result", symbol.comment, return_comment, ParameterDirection.OUT, constructor, true);
} else if (!constructor) {
write_implicit_params (return_type, ref index, return_array_length, "result", ParameterDirection.OUT);
}
buffer.append_printf (">\n");
indent++;
- write_doc (get_delegate_comment (cb));
+ write_doc (get_delegate_comment (cb), cb.comment);
- write_params_and_return ("callback", cb.get_parameters (), cb.get_type_parameters (), cb.return_type, get_ccode_array_length (cb), get_delegate_return_comment (cb), false, null, cb.has_target);
+ write_params_and_return (cb, "callback", cb.get_parameters (), cb.get_type_parameters (), cb.return_type, get_ccode_array_length (cb), get_delegate_return_comment (cb), false, null, cb.has_target);
indent--;
write_indent ();
string? return_comment = null;
if (write_comment) {
return_comment = get_method_return_comment (m);
- write_doc (get_method_comment (m));
+ write_doc (get_method_comment (m), m.comment);
}
- write_params_and_return (tag_name, params, m.get_type_parameters (), return_type, get_ccode_array_length (m), return_comment, false, m.this_parameter);
+ write_params_and_return (m, tag_name, params, m.get_type_parameters (), return_type, get_ccode_array_length (m), return_comment, false, m.this_parameter);
indent--;
write_indent ();
buffer.append_printf (">\n");
indent++;
- write_doc (get_method_comment (m));
+ write_doc (get_method_comment (m), m.comment);
var datatype = SemanticAnalyzer.get_data_type_for_symbol (m.parent_symbol);
List<TypeParameter>? type_params = null;
if (m.parent_symbol is Class) {
type_params = ((Class) m.parent_symbol).get_type_parameters ();
}
- write_params_and_return (tag_name, m.get_parameters (), type_params, datatype, false, get_method_return_comment (m), true);
+ write_params_and_return (m, tag_name, m.get_parameters (), type_params, datatype, false, get_method_return_comment (m), true);
indent--;
write_indent ();
buffer.append_printf (">\n");
indent++;
- write_doc (get_property_comment (prop));
+ write_doc (get_property_comment (prop), prop.comment);
write_type (prop.property_type);
buffer.append_printf (">\n");
indent++;
- write_doc (get_signal_comment (sig));
+ write_doc (get_signal_comment (sig), sig.comment);
- write_params_and_return ("glib:signal", sig.get_parameters (), null, sig.return_type, false, get_signal_return_comment (sig));
+ write_params_and_return (sig, "glib:signal", sig.get_parameters (), null, sig.return_type, false, get_signal_return_comment (sig));
indent--;
write_indent ();
}
- private void write_param_or_return (DataType? type, string tag, ref int index, bool has_array_length, string? name = null, string? comment = null, ParameterDirection direction = ParameterDirection.IN, bool constructor = false, bool caller_allocates = false, bool ellipsis = false) {
+ private void write_param_or_return (DataType? type, string tag, ref int index, bool has_array_length, string? name = null, Comment? parent_comment = null, string? comment = null, ParameterDirection direction = ParameterDirection.IN, bool constructor = false, bool caller_allocates = false, bool ellipsis = false) {
write_indent ();
buffer.append_printf ("<%s", tag);
if (ellipsis) {
buffer.append_printf (">\n");
indent++;
- write_doc (comment);
+ write_doc (comment, parent_comment);
if (ellipsis) {
write_indent ();
<c:include name="girtest.h"/>
<namespace name="GirTest" version="1.0" c:prefix="GirTest" c:identifier-prefixes="GirTest" c:symbol-prefixes="gir_test">
<enumeration name="EnumTest" c:type="GirTestEnumTest" glib:type-name="GirTestEnumTest" glib:get-type="gir_test_enum_test_get_type">
- <doc xml:whitespace="preserve"><para>An example comment for an example enum.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="40" column="2"><para>An example comment for an example enum.</para></doc>
<member name="value1" c:identifier="GIR_TEST_ENUM_TEST_VALUE1" value="0"/>
</enumeration>
<enumeration name="ErrorTest" c:type="GirTestErrorTest" glib:type-name="GirTestErrorTest" glib:get-type="gir_test_error_test_get_type" glib:error-domain="gir-test-error-test-quark">
- <doc xml:whitespace="preserve"><para>An example comment for an example errordomain.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="47" column="2"><para>An example comment for an example errordomain.</para></doc>
<member name="value1" c:identifier="GIR_TEST_ERROR_TEST_VALUE1" value="0"/>
</enumeration>
<class name="ObjectTest" c:type="GirTestObjectTest" c:symbol-prefix="object_test" glib:type-name="GirTestObjectTest" glib:get-type="gir_test_object_test_get_type" glib:type-struct="ObjectTestClass" parent="GObject.Object">
- <doc xml:whitespace="preserve"><para>An example comment for an example class.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="75" column="2"><para>An example comment for an example class.</para></doc>
<field name="parent_instance" readable="0" private="1">
<type name="GObject.Object" c:type="GObject"/>
</field>
<type name="ObjectTestPrivate" c:type="GirTestObjectTestPrivate*"/>
</field>
<constructor name="new" c:identifier="gir_test_object_test_new">
- <doc xml:whitespace="preserve"><para>An example comment for an example class constructor.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="89" column="3"><para>An example comment for an example class constructor.</para></doc>
<return-value transfer-ownership="full">
<type name="GirTest.ObjectTest" c:type="GirTestObjectTest*"/>
</return-value>
<parameters>
<parameter name="param" transfer-ownership="none">
- <doc xml:whitespace="preserve"><para>An example comment for an example parameter. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="89" column="3"><para>An example comment for an example parameter. </para></doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</constructor>
<method name="method" c:identifier="gir_test_object_test_method">
- <doc xml:whitespace="preserve"><para>An example comment for an example class method.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="96" column="3"><para>An example comment for an example class method.</para></doc>
<return-value transfer-ownership="full">
- <doc xml:whitespace="preserve"><para>An example comment for an example return value. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="96" column="3"><para>An example comment for an example return value. </para></doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<type name="GirTest.ObjectTest" c:type="GirTestObjectTest*"/>
</instance-parameter>
<parameter name="param" transfer-ownership="none">
- <doc xml:whitespace="preserve"><para>An example comment for an example parameter. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="96" column="3"><para>An example comment for an example parameter. </para></doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<property name="property" writable="1" construct="1">
- <doc xml:whitespace="preserve"><para>An example comment for an example property.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="79" column="3"><para>An example comment for an example property.</para></doc>
<type name="gint" c:type="gint"/>
</property>
<method name="get_property" c:identifier="gir_test_object_test_get_property">
</parameters>
</method>
<glib:signal name="some-signal">
- <doc xml:whitespace="preserve"><para>An example comment for an example signal.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="83" column="3"><para>An example comment for an example signal.</para></doc>
<return-value transfer-ownership="full">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="param" transfer-ownership="none">
- <doc xml:whitespace="preserve"><para>An example comment for an example parameter. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="83" column="3"><para>An example comment for an example parameter. </para></doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</record>
<record name="ObjectTestPrivate" c:type="GirTestObjectTestPrivate" disguised="1"/>
<interface name="InterfaceTest" c:type="GirTestInterfaceTest" c:symbol-prefix="interface_test" glib:type-name="GirTestInterfaceTest" glib:get-type="gir_test_interface_test_get_type" glib:type-struct="InterfaceTestIface">
- <doc xml:whitespace="preserve"><para>An example comment for an example interface.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="62" column="2"><para>An example comment for an example interface.</para></doc>
<prerequisite name="GObject.Object"/>
<method name="method" c:identifier="gir_test_interface_test_method">
- <doc xml:whitespace="preserve"><para>An example comment for an example interface method.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="66" column="3"><para>An example comment for an example interface method.</para></doc>
<return-value transfer-ownership="full">
- <doc xml:whitespace="preserve"><para>An example comment for an example return value. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="66" column="3"><para>An example comment for an example return value. </para></doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<type name="GirTest.InterfaceTest" c:type="GirTestInterfaceTest*"/>
</instance-parameter>
<parameter name="param" transfer-ownership="none">
- <doc xml:whitespace="preserve"><para>An example comment for an example parameter. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="66" column="3"><para>An example comment for an example parameter. </para></doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<virtual-method name="method" invoker="method">
- <doc xml:whitespace="preserve"><para>An example comment for an example interface method.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="66" column="3"><para>An example comment for an example interface method.</para></doc>
<return-value transfer-ownership="full">
- <doc xml:whitespace="preserve"><para>An example comment for an example return value. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="66" column="3"><para>An example comment for an example return value. </para></doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<type name="GirTest.InterfaceTest" c:type="GirTestInterfaceTest*"/>
</instance-parameter>
<parameter name="param" transfer-ownership="none">
- <doc xml:whitespace="preserve"><para>An example comment for an example parameter. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="66" column="3"><para>An example comment for an example parameter. </para></doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
<type name="GirTest.InterfaceTest" c:type="GirTestInterfaceTest*"/>
</parameter>
<parameter name="param" transfer-ownership="none">
- <doc xml:whitespace="preserve"><para>An example comment for an example parameter. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="66" column="3"><para>An example comment for an example parameter. </para></doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</field>
</record>
<record name="StructTest" c:type="GirTestStructTest" c:symbol-prefix="struct_test" glib:type-name="GirTestStructTest" glib:get-type="gir_test_struct_test_get_type">
- <doc xml:whitespace="preserve"><para>An example comment for an example struct.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="14" column="2"><para>An example comment for an example struct.</para></doc>
<field name="field" writable="1">
- <doc xml:whitespace="preserve"><para>An example comment for an example field.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="18" column="3"><para>An example comment for an example field.</para></doc>
<type name="gint" c:type="gint"/>
</field>
<method name="init" c:identifier="gir_test_struct_test_init">
- <doc xml:whitespace="preserve"><para>An example comment for an example struct constructor.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="22" column="3"><para>An example comment for an example struct constructor.</para></doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<type name="GirTest.StructTest" c:type="GirTestStructTest*"/>
</instance-parameter>
<parameter name="param" transfer-ownership="none">
- <doc xml:whitespace="preserve"><para>An example comment for an example parameter. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="22" column="3"><para>An example comment for an example parameter. </para></doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="method" c:identifier="gir_test_struct_test_method">
- <doc xml:whitespace="preserve"><para>An example comment for an example struct method.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="29" column="3"><para>An example comment for an example struct method.</para></doc>
<return-value transfer-ownership="full">
- <doc xml:whitespace="preserve"><para>An example comment for an example return value. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="29" column="3"><para>An example comment for an example return value. </para></doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<type name="GirTest.StructTest" c:type="GirTestStructTest*"/>
</instance-parameter>
<parameter name="param" transfer-ownership="none">
- <doc xml:whitespace="preserve"><para>An example comment for an example parameter. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="29" column="3"><para>An example comment for an example parameter. </para></doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
</record>
<callback name="DelegateTest" c:type="GirTestDelegateTest">
- <doc xml:whitespace="preserve"><para>An example comment for an example delegate.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="54" column="2"><para>An example comment for an example delegate.</para></doc>
<return-value transfer-ownership="full">
- <doc xml:whitespace="preserve"><para>An example comment for an example return value. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="54" column="2"><para>An example comment for an example return value. </para></doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="param" transfer-ownership="none">
- <doc xml:whitespace="preserve"><para>An example comment for an example parameter. </para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="54" column="2"><para>An example comment for an example parameter. </para></doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="1">
</parameters>
</callback>
<constant name="CONSTANT" c:identifier="GIR_TEST_CONSTANT" value="42">
- <doc xml:whitespace="preserve"><para>An example comment for an example constant.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="3" column="2"><para>An example comment for an example constant.</para></doc>
<type name="gint" c:type="gint"/>
</constant>
<function name="function" c:identifier="gir_test_function">
- <doc xml:whitespace="preserve"><para>An example comment for an example function.</para></doc>
+ <doc xml:space="preserve" filename="girtest.vala" line="8" column="2"><para>An example comment for an example function.</para></doc>
<return-value transfer-ownership="full">
<type name="none" c:type="void"/>
</return-value>
projects / thirdparty / vala.git / commitdiff
