From 3e9a9e869e47ab4618c13f6374c94d37aacfd608 Mon Sep 17 00:00:00 2001
From: Dominik Holland <dominik.holland@pelagicore.com>
Date: Wed, 23 Jan 2019 15:46:49 +0100
Subject: ivigenerator: Don't use the javadoc syntax in our qface files

In theory the documentation inside the qface files could be
transformed using the javadoc syntax and the parse_doc filter
function, but so far we only supported the brief tag and already
used qdoc commands in the function directly. As the tag functionality
of parse_doc is nothing we can really use, better use qdoc commands
in the qface documentation right away.

Change-Id: I9b23fe84acc6cd942e6fa7ec5933911b84ce22ec
Reviewed-by: Robert Griebl <robert.griebl@pelagicore.com>
---
 .../auto/core/ivigenerator/org.example.echo.qface  | 32 ++++++++--------------
 .../core/ivigenerator/org.example.echo.qtro.qface  | 17 ++++--------
 .../ivigenerator/org.example.echo.simulator.qface  | 23 +++++-----------
 3 files changed, 24 insertions(+), 48 deletions(-)

(limited to 'tests')

diff --git a/tests/auto/core/ivigenerator/org.example.echo.qface b/tests/auto/core/ivigenerator/org.example.echo.qface
index 118cf63..ae6249c 100644
--- a/tests/auto/core/ivigenerator/org.example.echo.qface
+++ b/tests/auto/core/ivigenerator/org.example.echo.qface
@@ -5,23 +5,16 @@
 module org.example.echo 1.0
 
 /**
- * @brief the brief
- * @description the description
- * continues {@link http://qt.io}
- * @deprecated
- * @see org.example.echo.Echo
- * @see org.example
- * @see http://qt.io
- * @anything hello
+ * \brief the brief
+ * the description
+ * continues \l http://qt.io
  */
 @config: {id: "org.foo.id.1.0", qml_class_name: "UiEcho"}
 interface Echo {
     /**
-     * @brief brief message
-     * @details long message
+     * \brief brief message
      *
-     * @param msg the message
-     * @return the echo
+     * Some more documentation
      */
     readonly string lastMessage;
     int intValue;
@@ -50,12 +43,11 @@ interface Echo {
 
 @config: {id: "org.foo.idz.1.0", zoned: true}
 interface EchoZoned {
+
     /**
-     * @brief brief message
-     * @details long message
+     * \brief brief message
      *
-     * @param msg the message
-     * @return the echo
+     * Some more documentation
      */
     readonly string lastMessage;
     int intValue;
@@ -86,19 +78,19 @@ interface EchoZoned {
 }
 
 /**
- * @brief Control where the airflow goes
+ * \brief Control where the airflow goes
  */
 flag AirflowDirection {
     /**
-     * @brief Airflow to the windshield
+     * \brief Airflow to the windshield
      */
     Windshield = 1,
     /**
-     * @brief Airflow to the dashboard
+     * \brief Airflow to the dashboard
      */
     Dashboard = 2,
     /**
-     * @brief Airflow to the floor
+     * \brief Airflow to the floor
      */
     Floor = 4
 }
diff --git a/tests/auto/core/ivigenerator/org.example.echo.qtro.qface b/tests/auto/core/ivigenerator/org.example.echo.qtro.qface
index 9d4b93b..79d691b 100644
--- a/tests/auto/core/ivigenerator/org.example.echo.qtro.qface
+++ b/tests/auto/core/ivigenerator/org.example.echo.qtro.qface
@@ -5,23 +5,16 @@
 module org.example.echo 1.0
 
 /**
- * @brief the brief
- * @description the description
- * continues {@link http://qt.io}
- * @deprecated
- * @see org.example.echo.Echo
- * @see org.example
- * @see http://qt.io
- * @anything hello
+ * \brief the brief
+ * the description
+ * continues \l http://qt.io
  */
 @config: {id: "org.foo.id.1.0", qml_class_name: "UiEcho"}
 interface Echo {
     /**
-     * @brief brief message
-     * @details long message
+     * \brief brief message
      *
-     * @param msg the message
-     * @return the echo
+     * Some more documentation
      */
     readonly string lastMessage;
     int intValue;
diff --git a/tests/auto/core/ivigenerator/org.example.echo.simulator.qface b/tests/auto/core/ivigenerator/org.example.echo.simulator.qface
index 3d77205..6b39cd2 100644
--- a/tests/auto/core/ivigenerator/org.example.echo.simulator.qface
+++ b/tests/auto/core/ivigenerator/org.example.echo.simulator.qface
@@ -4,23 +4,16 @@
 module org.example.simulator.echo 1.0
 
 /**
- * @brief the brief
- * @description the description
- * continues {@link http://qt.io}
- * @deprecated
- * @see org.example.echo.Echo
- * @see org.example
- * @see http://qt.io
- * @anything hello
+ * \brief the brief
+ * the description
+ * continues \l http://qt.io
  */
 @config: {"id": "org.foo.id.1.0"}
 interface Echo {
     /**
-     * @brief brief message
-     * @details long message
+     * \brief brief message
      *
-     * @param msg the message
-     * @return the echo
+     * Some more documentation
      */
     readonly string lastMessage;
     int intValue;
@@ -35,11 +28,9 @@ interface Echo {
 @config: {"id": "org.foo.idz.1.0", "zoned": true}
 interface EchoZoned {
     /**
-     * @brief brief message
-     * @details long message
+     * \brief brief message
      *
-     * @param msg the message
-     * @return the echo
+     * Some more documentation
      */
     readonly string lastMessage;
     int intValue;
-- 
cgit v1.2.1