[vala/wip/docs: 1/3] Fix syntax of several documentation blocks



commit 297735c6a52054d4967a84986e9a45129448b1ad
Author: Rico Tzschichholz <ricotz ubuntu com>
Date:   Wed Sep 6 08:49:53 2017 +0200

    Fix syntax of several documentation blocks

 codegen/valatyperegisterfunction.vala |    2 --
 gee/timsort.vala                      |    4 ++--
 libvaladoc/api/callable.vala          |    2 --
 libvaladoc/api/field.vala             |    2 --
 libvaladoc/api/formalparameter.vala   |    2 --
 libvaladoc/api/property.vala          |    2 --
 6 files changed, 2 insertions(+), 12 deletions(-)
---
diff --git a/codegen/valatyperegisterfunction.vala b/codegen/valatyperegisterfunction.vala
index 5f8d2be..72793cd 100644
--- a/codegen/valatyperegisterfunction.vala
+++ b/codegen/valatyperegisterfunction.vala
@@ -413,8 +413,6 @@ public abstract class Vala.TypeRegisterFunction {
 
        /**
         * Returns additional C initialization statements to setup interfaces.
-        *
-        * @return C statements
         */
        public virtual void get_type_interface_init_statements (CCodeBlock block, bool plugin) {
        }
diff --git a/gee/timsort.vala b/gee/timsort.vala
index 58c4d08..e8efa23 100644
--- a/gee/timsort.vala
+++ b/gee/timsort.vala
@@ -31,10 +31,10 @@
  *
  * This implementation was adapted from Tim Peters's list sort for Python,
  * which is described in detail here:
- *   [[http://svn.python.org/projects/python/trunk/Objects/listsort.txt]]
+ * [[http://svn.python.org/projects/python/trunk/Objects/listsort.txt]]
  *
  * Tim's C code may be found here:
- *   [[http://svn.python.org/projects/python/trunk/Objects/listobject.c]]
+ * [[http://svn.python.org/projects/python/trunk/Objects/listobject.c]]
  *
  * The underlying techniques are described in this paper (and may have even
  * earlier origins):
diff --git a/libvaladoc/api/callable.vala b/libvaladoc/api/callable.vala
index 29d965d..8973ad6 100644
--- a/libvaladoc/api/callable.vala
+++ b/libvaladoc/api/callable.vala
@@ -29,8 +29,6 @@ using Valadoc;
 public interface Valadoc.Api.Callable : Symbol {
        /**
         * The return type of this symbol.
-        *
-        * @return The return type of this symbol or null for void
         */
        public abstract TypeReference? return_type {
                set;
diff --git a/libvaladoc/api/field.vala b/libvaladoc/api/field.vala
index d7a87a2..2844faa 100644
--- a/libvaladoc/api/field.vala
+++ b/libvaladoc/api/field.vala
@@ -50,8 +50,6 @@ public class Valadoc.Api.Field : Member {
 
        /**
         * The field type.
-        *
-        * @return The field type or null for void
         */
        public TypeReference? field_type {
                set;
diff --git a/libvaladoc/api/formalparameter.vala b/libvaladoc/api/formalparameter.vala
index 58c4c42..f22b5bc 100644
--- a/libvaladoc/api/formalparameter.vala
+++ b/libvaladoc/api/formalparameter.vala
@@ -95,8 +95,6 @@ public class Valadoc.Api.FormalParameter : Symbol {
 
        /**
         * The parameter type.
-        *
-        * @return The parameter type or null for void
         */
        public TypeReference? parameter_type {
                set;
diff --git a/libvaladoc/api/property.vala b/libvaladoc/api/property.vala
index 235292f..d981c90 100644
--- a/libvaladoc/api/property.vala
+++ b/libvaladoc/api/property.vala
@@ -60,8 +60,6 @@ public class Valadoc.Api.Property : Member {
 
        /**
         * The property type.
-        *
-        * @return The property type or null for void
         */
        public TypeReference? property_type {
                set;


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]