Changed all examples files to use JavaDoc tags

5 files changed, 62 insertions, 41 deletions

diff --git a/examples/interfaces/echo.qface b/examples/interfaces/echo.qface
index bbde9d6..ed58685 100644
--- a/examples/interfaces/echo.qface
+++ b/examples/interfaces/echo.qface
@@ -1,14 +1,14 @@
 module org.example 1.0;
 
-/*!
+/**
  * Provide a simple echo service.
  */
 interface Echo {
-    /*!
+    /**
      * The last echo message.
      */
     string currentMessage;
-    /*!
+    /**
      * Returns the passed in message
      */
     void echo(Message message);
diff --git a/tests/in/com.pelagicore.ivi.climate.qface b/tests/in/com.pelagicore.ivi.climate.qface
index 6414bb5..b465e8b 100644
--- a/tests/in/com.pelagicore.ivi.climate.qface
+++ b/tests/in/com.pelagicore.ivi.climate.qface
@@ -1,86 +1,86 @@
 module com.pelagicore.ivi.climate 1.0;
 
-/*!
+/**
  * The ClimateControl provides a QML interface to the climate control
  * of the vehicle.
  */
 interface ClimateControl {
-    /*!
+    /**
      * Value is true if the air conditioning is enabled.
      */
     bool airConditioning;
-    /*!
+    /**
      * value holds the airflow directions
      */
     AirflowDirections airflowDirections;
-    /*!
+    /**
      * value is true if the heater is enabled.
      */
     bool heater;
-    /*!
+    /**
      * value holds the fan speed level, where the level can be between
      * minimumValue(off) to maximumValue (strongest).
      */
     int fanSpeedLevel;
-    /*!
+    /**
      * value holds the steering wheel heater level, where the level can
      * be between minimumValue(off) to maximumValue (warmest).
      */
     int steeringWheelHeater;
-    /*!
+    /**
      * value holds the target temperature of the zone expressed
      * in centigrades, where the temperature can be between
      * minimumValue(coolest) to maximumValue (warmest).
      */
     int targetTemperature;
-    /*!
+    /**
      * value holds the seat cooler level, where the level can be
      * between minimumValue(off) to maximumValue (coolest).
      */
     int seatCooler;
-    /*!
+    /**
      * value holds the seat heater level, where the level can be between
      * minimumValue(off) to maximumValue (warmest).
      */
     int seatHeater;
-    /*!
+    /**
      * value holds the outside temperature of the zone expressed in
      * centigrades, where the temperature can be between
      * minimumValue(coolest) to maximumValue (warmest).
      */
     int outsideTemperature;
-    /*!
+    /**
      * value is true if the zone synchronization is enabled.
      *
      * Which zones and properties are synchronized is controlled
      * by the backend implementing it.
      */
     bool zoneSynchronization;
-    /*!
+    /**
      * value is true if defrost is enabled. Usually that means that the fans
      * are on the highest level to remove ice from the windshield.
      */
     bool defrost;
-    /*!
+    /**
      * value holds the recirculation mode
      */
     RecirculationMode recirculationMode;
-    /*!
+    /**
      * value is true if the recirculation is currently running.
      */
     bool recirculation;
-    /*!
+    /**
      * value holds the sensitivity level of the recirculation
      * system when the recirculationMode is set to AutoRecirculation,
      * where the level can be between minimumValue(least sensitive)
      * to maximumValue(most sensitive).
      */
-    int recirculationSensitivityLevel;    
-    /*!
+    int recirculationSensitivityLevel;
+    /**
      * value holds the climate mode
      */
-    ClimateMode climateMode;    
-    /*!
+    ClimateMode climateMode;
+    /**
      * value holds the intensity level of the fan when the climateMode
      * is set to AutoClimate, where the level can be between
      * minimumValue(least intensity) to maximumValue(most intensity).
diff --git a/tests/in/com.pelagicore.ivi.tuner.qface b/tests/in/com.pelagicore.ivi.tuner.qface
index 36fab03..f8eb4af 100644
--- a/tests/in/com.pelagicore.ivi.tuner.qface
+++ b/tests/in/com.pelagicore.ivi.tuner.qface
@@ -1,17 +1,17 @@
 module com.pelagicore.ivi.tuner 1.0;
 
-/*! Service Tuner */
+/** Service Tuner */
 @service()
 @interface()
 interface Tuner {
-    /*! property currentStation */
+    /** property currentStation */
     readonly Station currentStation;
-    /*! operation nextStation */
+    /** operation nextStation */
     void nextStation();
-    /*! operation previousStation */
+    /** operation previousStation */
     void previousStation();
-    /*! operation updateCurrentStation */
-    void updateCurrentStation(int stationId);   
+    /** operation updateCurrentStation */
+    void updateCurrentStation(int stationId);
 
     list<int> primitiveList;
     list<Station> complexList;
@@ -19,24 +19,24 @@ interface Tuner {
     model<Station> complexModel;
 }
 
-/*! enum State */
+/** enum State */
 enum State {
-    /*! value State.Null */
+    /** value State.Null */
     Null=0,
-    /*! value State.Loading */
+    /** value State.Loading */
     Loading=1,
-    /*! value State.Ready */
+    /** value State.Ready */
     Ready=2,
-    /*! value State.Error */
+    /** value State.Error */
     Error=3
 }
 
-/*! enum Waveband */
+/** enum Waveband */
 @default(value=FM)
 enum Waveband {
-    /*! value Waveband.FM */
+    /** value Waveband.FM */
     FM=0,
-    /*! value Waveband.AM */
+    /** value Waveband.AM */
     AM=1
 }
 
@@ -45,13 +45,13 @@ flag Features {
     Stereo = 0x2,
 }
 
-/*! struct Station */
+/** struct Station */
 struct Station {
-    /*! member stationId */
+    /** member stationId */
     int stationId;
-    /*! member name */
+    /** member name */
     string name;
-} 
+}
 
 
 
diff --git a/tests/in/com.pelagicore.test.qface b/tests/in/com.pelagicore.test.qface
index 07ecf1f..c3b5cbf 100644
--- a/tests/in/com.pelagicore.test.qface
+++ b/tests/in/com.pelagicore.test.qface
@@ -35,7 +35,7 @@ flag Phase {
   PhaseThree
 }
 
-/*!
+/**
  * The contact information
  */
 struct Contact {
diff --git a/tests/in/org.example.echo.qface b/tests/in/org.example.echo.qface
new file mode 100644
index 0000000..4930b33
--- /dev/null
+++ b/tests/in/org.example.echo.qface
@@ -0,0 +1,21 @@
+/** module */
+module org.example.echo 1.0
+
+/**
+ * @brief the brief
+ * @description The description
+ * continues on another line which can be very long, indeed. Still not long enough
+ * @deprecated
+ */
+interface Echo {
+    /**
+     * @brief brief message
+     * @details long message
+     *
+     * @param msg the messsage
+     * @return the echo
+     */
+    string echo(string msg);
+
+}
+