Browse Source

improve documentation

Kolja Strohm 8 months ago
parent
commit
04af4de785
16 changed files with 250 additions and 250 deletions
  1. 1 1
      AlphaFeld.h
  2. 39 39
      Animation3D.h
  3. 1 1
      Array.h
  4. 40 40
      AuswahlBox.h
  5. 6 6
      Bild.h
  6. 68 68
      Fenster.h
  7. 20 20
      Fortschritt.h
  8. 10 10
      GraphicsApi.h
  9. 23 23
      Liste.h
  10. 3 3
      Model3D.h
  11. 1 1
      Text.h
  12. 15 15
      TextFeld.h
  13. 2 2
      Thread.h
  14. 1 1
      XML.h
  15. 15 15
      Zeichnung.h
  16. 5 5
      Zeit.h

+ 1 - 1
AlphaFeld.h

@@ -19,7 +19,7 @@ namespace Framework
     public:
         //! Konstruktor
         DLLEXPORT AlphaFeld();
-        // Destruktor
+        //! Destruktor
         DLLEXPORT virtual ~AlphaFeld();
         //! Setzt die Stärke des Übergangs. Dies ist der Wert um den der Alpha
         //! Wert der Farbe für jeden Pixel nach innen abnimmt \param st Die

+ 39 - 39
Animation3D.h

@@ -27,17 +27,17 @@ namespace Framework
         bool loop;
 
     public:
-        // create an animation for a specific bone
-        // \param boneId the id of the bone
-        // \param originPos the position of the bone at the beginning of the
-        // animation
-        // \param originRot the rotation of the bone at the beginning of the
-        // animation
+        //! create an animation for a specific bone
+        //! \param boneId the id of the bone
+        //! \param originPos the position of the bone at the beginning of the
+        //! animation
+        //! \param originRot the rotation of the bone at the beginning of the
+        //! animation
         DLLEXPORT BoneAnimation(
             int boneId, Vec3<float> originPos, Vec3<float> originRot);
-        // destructor
+        //! destructor
         DLLEXPORT ~BoneAnimation();
-        // make the animation to a loop that starts again if the end is reached
+        //! make the animation to a loop that starts again if the end is reached
         DLLEXPORT void setLoop(bool loop);
         //! adds a keyframe
         //! \param time the time in seconds since the start of the animation at
@@ -46,22 +46,22 @@ namespace Framework
         //! the rotation of the bone
         DLLEXPORT void addKeyFrame(
             double time, Vec3<float> pos, Vec3<float> rot);
-        // adds a keyframe that is the same as the last keyframe with the time
-        // time \returns true if the keyframe was added successfully, false if
-        // time is maller than the current length of the animation
+        //! adds a keyframe that is the same as the last keyframe with the time
+        //! time \returns true if the keyframe was added successfully, false if
+        //! time is maller than the current length of the animation
         DLLEXPORT bool doNothingUntil(double time);
-        // calculates the positions and rotation at the next time
-        // \param time the passed time in seconds since the last call
+        //! calculates the positions and rotation at the next time
+        //! \param time the passed time in seconds since the last call
         DLLEXPORT void tick(double time);
         //! applys the animation on a given skeleton
         //! \param zS: the skeleton
         DLLEXPORT void apply(Skeleton* zSkelett) const;
-        // returns true if the animation has reached the last keyframe and does
-        // not loop
+        //! returns true if the animation has reached the last keyframe and does
+        //! not loop
         DLLEXPORT bool isFinished() const;
-        // returns the bone id this animation is for
+        //! returns the bone id this animation is for
         DLLEXPORT int getBoneId() const;
-        // returns the maximum time of the animation
+        //! returns the maximum time of the animation
         DLLEXPORT double getMaxTime() const;
     };
 
@@ -74,39 +74,39 @@ namespace Framework
     public:
         //! Constructor
         DLLEXPORT SkeletonAnimation();
-        // make the animation to a loop that starts again if the end is reached
+        //! make the animation to a loop that starts again if the end is reached
         DLLEXPORT void setLoop(bool loop);
-        // adds an animation for a specific bone
-        // \param boneId the bone id
-        // \param originPos the position of the bone at the beginning of the
-        // animation \param originRot the rotation of the bone at the beginning
-        // of the animation \return true if the animation was added, false if
-        // there is already an animation for that bone
+        //! adds an animation for a specific bone
+        //! \param boneId the bone id
+        //! \param originPos the position of the bone at the beginning of the
+        //! animation \param originRot the rotation of the bone at the beginning
+        //! of the animation \return true if the animation was added, false if
+        //! there is already an animation for that bone
         DLLEXPORT bool addAnimation(
             int boneId, Vec3<float> originPos, Vec3<float> originRot);
-        // adds a keyframe for a specific bone of the sceleton
-        // \param boneId id of the bone
-        // \param time the time in seconds since the start of the animation at
-        // which the bone should have the given position and rotation relative
-        // to its parent bone
-        // \param pos the position of the bone
-        // \param rot the rotation of the bone
-        // \return true if the frame was added, false if there is no annimation
-        // for that bone
+        //! adds a keyframe for a specific bone of the sceleton
+        //! \param boneId id of the bone
+        //! \param time the time in seconds since the start of the animation at
+        //! which the bone should have the given position and rotation relative
+        //! to its parent bone
+        //! \param pos the position of the bone
+        //! \param rot the rotation of the bone
+        //! \return true if the frame was added, false if there is no annimation
+        //! for that bone
         DLLEXPORT bool addKeyFrame(
             int boneId, double time, Vec3<float> pos, Vec3<float> rot);
         //! applys the animation on a given skeleton
         //! \param zS: the sceleton
         DLLEXPORT void apply(Skeleton* zS) const;
-        // calculates the positions and rotation at the next time
-        // \param time the passed time in seconds since the last call
+        //! calculates the positions and rotation at the next time
+        //! \param time the passed time in seconds since the last call
         DLLEXPORT void tick(double time);
-        // returns true if the animation has reached the last keyframe and does
-        // not loop
+        //! returns true if the animation has reached the last keyframe and does
+        //! not loop
         DLLEXPORT bool isFinished() const;
-        // returns the maximum time of the animation
+        //! returns the maximum time of the animation
         DLLEXPORT double getMaxTime() const;
-        // returns the animation for a specific bone or 0 if it does not exist
+        //! returns the animation for a specific bone or 0 if it does not exist
         DLLEXPORT BoneAnimation* zAnimation(int boneId) const;
     };
 } // namespace Framework

+ 1 - 1
Array.h

@@ -832,7 +832,7 @@ namespace Framework
             return i >= 0 && i < count;
         }
 
-        // returns the index of the first element that matches zT or -1 if not found
+        //! returns the index of the first element that matches zT or -1 if not found
         int indexOf(TYP* zT) const
         {
             int i = 0;

+ 40 - 40
AuswahlBox.h

@@ -23,64 +23,64 @@ namespace Framework
         class Style : public ZeichnungHintergrund::Style
         {
         public:
-            // Wenn dieser Flag gesetzt ist, hat jeder Wert aus der Liste einen
-            // Rahmen
+            //! Wenn dieser Flag gesetzt ist, hat jeder Wert aus der Liste einen
+            //! Rahmen
             static const __int64 FeldRahmen = 0x000001000;
-            // Wenn dieser Flag gesetzt ist, hat jeder Wert aus der Liste einen
-            // Hintergrund
+            //! Wenn dieser Flag gesetzt ist, hat jeder Wert aus der Liste einen
+            //! Hintergrund
             static const __int64 FeldHintergrund = 0x000002000;
-            // Wenn dieser Flag gesetzt ist, hat jeder Wert aus der Liste ein
-            // Bild als Hintergrund
+            //! Wenn dieser Flag gesetzt ist, hat jeder Wert aus der Liste ein
+            //! Bild als Hintergrund
             static const __int64 FeldHBild = 0x000004000;
-            // Wenn dieser Flag gesetzt ist, hat jeder Wert aus der Liste einen
-            // Transparenten Hintergrund
+            //! Wenn dieser Flag gesetzt ist, hat jeder Wert aus der Liste einen
+            //! Transparenten Hintergrund
             static const __int64 FeldHAlpha = 0x000008000;
-            // Wenn dieser Flag gesetzt ist, hat jeder Wert aus der Liste einen
-            // Farbübergang
+            //! Wenn dieser Flag gesetzt ist, hat jeder Wert aus der Liste einen
+            //! Farbübergang
             static const __int64 FeldBuffer = 0x000010000;
-            // Wenn dieser Flag gesetzt ist, bekommt der Wert, der gerade
-            // ausgewählt  Hintergrund
+            //! Wenn dieser Flag gesetzt ist, bekommt der Wert, der gerade
+            //! ausgewählt  Hintergrund
             static const __int64 AuswahlHintergrund = 0x000020000;
-            // Wenn dieser Flag gesetzt ist, bekommt der Wert, der gerade
-            // ausgewählt ist ein Hintergrundbild
+            //! Wenn dieser Flag gesetzt ist, bekommt der Wert, der gerade
+            //! ausgewählt ist ein Hintergrundbild
             static const __int64 AuswahlHBild = 0x000040000;
-            // Wenn dieser Flag gesetzt ist, bekommt der Wert, der gerade
-            // ausgewählt ist einen transparenten Hintergrund
+            //! Wenn dieser Flag gesetzt ist, bekommt der Wert, der gerade
+            //! ausgewählt ist einen transparenten Hintergrund
             static const __int64 AuswahlHAlpha = 0x000080000;
-            // Wenn dieser Flag gesetzt ist, bekommt der Wert, der gerade
-            // ausgewählt ist einen Farbübergang
+            //! Wenn dieser Flag gesetzt ist, bekommt der Wert, der gerade
+            //! ausgewählt ist einen Farbübergang
             static const __int64 AuswahlBuffer = 0x000100000;
-            // Wenn dieser Flag gesetzt ist, bekommt der Wert, der gerade
-            // ausgewählt ist einen Rahmen
+            //! Wenn dieser Flag gesetzt ist, bekommt der Wert, der gerade
+            //! ausgewählt ist einen Rahmen
             static const __int64 AuswahlRahmen = 0x000200000;
-            // Wenn dieser Flag gesetzt ist, hat jeder Wert seine eigenen
-            // Hintergründe unt Rahmen und nicht alle die selben
+            //! Wenn dieser Flag gesetzt ist, hat jeder Wert seine eigenen
+            //! Hintergründe unt Rahmen und nicht alle die selben
             static const __int64 MultiStyled = 0x000400000;
-            // Legt eine maximale Höhe der ausgeklappten Liste fest. Es
-            // erscheint automatisch eine Scrollbar wenn mehr Elemente da sind
-            // als sichtbar sein können
+            //! Legt eine maximale Höhe der ausgeklappten Liste fest. Es
+            //! erscheint automatisch eine Scrollbar wenn mehr Elemente da sind
+            //! als sichtbar sein können
             static const __int64 MaxHeight = 0x004000000;
-            // Wenn dieser Flag gesetzt ist, hat ein Element, wo die Maus drau
-            // zeigt, einen Hintergrund
+            //! Wenn dieser Flag gesetzt ist, hat ein Element, wo die Maus drau
+            //! zeigt, einen Hintergrund
             static const __int64 MausHintergrund = 0x008000000;
-            // Wenn dieser Flag gesetzt ist, hat ein Element, wo die Maus drauf
-            // zeigt, ein Hintergrundbild
+            //! Wenn dieser Flag gesetzt ist, hat ein Element, wo die Maus drauf
+            //! zeigt, ein Hintergrundbild
             static const __int64 MausHBild = 0x010000000;
-            // Wenn dieser Flag gesetzt ist, hat ein Element, wo die Maus drauf
-            // zeigt, einen transparenten Hintergrund
+            //! Wenn dieser Flag gesetzt ist, hat ein Element, wo die Maus drauf
+            //! zeigt, einen transparenten Hintergrund
             static const __int64 MausHAlpha = 0x020000000;
-            // Wenn dieser Flag gesetzt ist, hat ein Element, wo die Maus drauf
-            // zeigt, einen Farbübergang
+            //! Wenn dieser Flag gesetzt ist, hat ein Element, wo die Maus drauf
+            //! zeigt, einen Farbübergang
             static const __int64 MausBuffer = 0x040000000;
-            // Wenn dieser Flag gesetzt ist, hat ein Element, wo die Maus drauf
-            // zeigt, einen Rahmen
+            //! Wenn dieser Flag gesetzt ist, hat ein Element, wo die Maus drauf
+            //! zeigt, einen Rahmen
             static const __int64 MausRahmen = 0x080000000;
-            // const int NachObenAusklappen	= 0x100000000;
-            // const int AutoAusklappRichtung	= 0x200000000;
+            //! const int NachObenAusklappen	= 0x100000000;
+            //! const int AutoAusklappRichtung	= 0x200000000;
 
-            // Normaler Style: Sichtbar, Erlaubt, Rahmen, FeldRahmen,
-            // AuswahlBuffer, AuswahlRahmen, MaxHöhe, VScroll, MausRahmen,
-            // MausBuffer
+            //! Normaler Style: Sichtbar, Erlaubt, Rahmen, FeldRahmen,
+            //! AuswahlBuffer, AuswahlRahmen, MaxHöhe, VScroll, MausRahmen,
+            //! MausBuffer
             static const __int64 Normal
                 = Sichtbar | Erlaubt | Rahmen | FeldRahmen | AuswahlBuffer
                 | AuswahlRahmen | MaxHeight | VScroll | MausRahmen | MausBuffer

+ 6 - 6
Bild.h

@@ -500,15 +500,15 @@ namespace Framework
         class Style : public ZeichnungHintergrund::Style
         {
         public:
-            // Wenn dieser Flag gesetzt ist, wird zum Zeichnen des Bildes Alpha
-            // Blending verwendet
+            //! Wenn dieser Flag gesetzt ist, wird zum Zeichnen des Bildes Alpha
+            //! Blending verwendet
             static const __int64 Alpha = 0x1000;
-            // Wenn dieser Flag gesetzt ist, wird das Bild in die Zeichenfläche
-            // skalliert
+            //! Wenn dieser Flag gesetzt ist, wird das Bild in die Zeichenfläche
+            //! skalliert
             static const __int64 Skalliert = 0x2000;
 
-            // Der Normale Style einer Bild Zeichnung Bestehend aus HScroll,
-            // Sichtbar, Erlaubt, Rahmen, VScroll
+            //! Der Normale Style einer Bild Zeichnung Bestehend aus HScroll,
+            //! Sichtbar, Erlaubt, Rahmen, VScroll
             static const __int64 normal
                 = HScroll | Sichtbar | Erlaubt | Rahmen | VScroll;
         };

+ 68 - 68
Fenster.h

@@ -281,117 +281,117 @@ namespace Framework
         class Style : public Zeichnung::Style
         {
         public:
-            // Legt fest, ob der Körper des Fensters einen Hintergrund hat
+            //! Legt fest, ob der Körper des Fensters einen Hintergrund hat
             static const __int64 BodyHintergrund = 0x000000008;
-            // Legt fest, ob beim zeichnen des Körperhintergrundes alpha
-            // blending verwendet werden soll
+            //! Legt fest, ob beim zeichnen des Körperhintergrundes alpha
+            //! blending verwendet werden soll
             static const __int64 BodyHAlpha = 0x000000010;
-            // Legt fest, ob ein Bild als Hintergrund des Körpers verwendet
-            // werden soll
+            //! Legt fest, ob ein Bild als Hintergrund des Körpers verwendet
+            //! werden soll
             static const __int64 BodyHBild = 0x000000020;
-            // Legt fest, ob der Körper einen Farbübergang besitzt
+            //! Legt fest, ob der Körper einen Farbübergang besitzt
             static const __int64 BodyBuffered = 0x000000040;
-            // Legt fest, ob das Fenster eine Titelleiste hat
+            //! Legt fest, ob das Fenster eine Titelleiste hat
             static const __int64 Titel = 0x000000080;
-            // Legt fest, ob die titelleiste des Fensters einen Hintergrund hat
+            //! Legt fest, ob die titelleiste des Fensters einen Hintergrund hat
             static const __int64 TitelHintergrund = 0x000000100;
-            // Legt fest, ob zum zeichnen des Titel Hintergrundes alpha
-            // blending soll
+            //! Legt fest, ob zum zeichnen des Titel Hintergrundes alpha
+            //! blending soll
             static const __int64 TitelHAlpha = 0x000000200;
-            // Legt fest, ob für den Titelhintergrund ein Bild verwendet werden
-            // soll
+            //! Legt fest, ob für den Titelhintergrund ein Bild verwendet werden
+            //! soll
             static const __int64 TitelHBild = 0x000000400;
-            // Legt fest, ob die Titel Leiste einen Farbübergang besitzt
+            //! Legt fest, ob die Titel Leiste einen Farbübergang besitzt
             static const __int64 TitelBuffered = 0x000000800;
-            // Legt fest, ob in der Titelleiste ein Knopf zum Schließen des
-            // Fensters angezeigt werden soll
+            //! Legt fest, ob in der Titelleiste ein Knopf zum Schließen des
+            //! Fensters angezeigt werden soll
             static const __int64 Closable = 0x000001000;
-            // Legt fest, ob der Schließen Knopf einen Hintergrund hat
+            //! Legt fest, ob der Schließen Knopf einen Hintergrund hat
             static const __int64 ClosingHintergrund = 0x000002000;
-            // Legt fest, ob beim Zeichnen des Hintergrunds des Schließen
-            // Knopfes alpha blending verwendet werden soll
+            //! Legt fest, ob beim Zeichnen des Hintergrunds des Schließen
+            //! Knopfes alpha blending verwendet werden soll
             static const __int64 ClosingHAlpha = 0x000004000;
-            // Legt fest, ob für den Hintergrund des Schließen Knopfes ein Bild
-            // soll
+            //! Legt fest, ob für den Hintergrund des Schließen Knopfes ein Bild
+            //! soll
             static const __int64 ClosingHBild = 0x000008000;
-            // Legt fest, ob der Schließen Knopf einen Farbübergang besitzt
+            //! Legt fest, ob der Schließen Knopf einen Farbübergang besitzt
             static const __int64 ClosingBuffer = 0x000010000;
-            // Legt fest, ob der Schließen Knopf einen Farbübergang besitzt,
-            // während er gedrückt wird
+            //! Legt fest, ob der Schließen Knopf einen Farbübergang besitzt,
+            //! während er gedrückt wird
             static const __int64 ClosingKlickBuffer = 0x000020000;
-            // Legt fest, ob der Benutzer das Fenster durch gedrückt halten der
-            // linken Maustaste in der Titelleiste das Fenster verschieben kann
+            //! Legt fest, ob der Benutzer das Fenster durch gedrückt halten der
+            //! linken Maustaste in der Titelleiste das Fenster verschieben kann
             static const __int64 Beweglich = 0x000040000;
-            // Legt fest, ob der Benutzer die Breite des Fensters durch das
-            // gedrückt halten der linken Maustaste auf dem rechten oder linken
-            // Fensterrand verändern kann
+            //! Legt fest, ob der Benutzer die Breite des Fensters durch das
+            //! gedrückt halten der linken Maustaste auf dem rechten oder linken
+            //! Fensterrand verändern kann
             static const __int64 BreiteChangeable = 0x000080000;
-            // Legt fest, ob der Benutzer die Höhe des Fensters durch das
-            // gedrückt halten der linken Maustaste auf dem oberen oder unteren
-            // Fensterrand verändern kann
+            //! Legt fest, ob der Benutzer die Höhe des Fensters durch das
+            //! gedrückt halten der linken Maustaste auf dem oberen oder unteren
+            //! Fensterrand verändern kann
             static const __int64 HeightChangeable = 0x000100000;
-            // Legt fest, ob der Benutzer die Höhe der Titel Leiste durch
-            // gedrückt halten der linken Maustaste auf dem unteren Rand der
-            // Titelleiste verändern kann
+            //! Legt fest, ob der Benutzer die Höhe der Titel Leiste durch
+            //! gedrückt halten der linken Maustaste auf dem unteren Rand der
+            //! Titelleiste verändern kann
             static const __int64 TitelHeightChangeable = 0x000200000;
-            // Legt fest, ob es eine Minimale Breite des Fensters gibt
+            //! Legt fest, ob es eine Minimale Breite des Fensters gibt
             static const __int64 MinBr = 0x000400000;
-            // Legt fest, ob es eine Maximale Breite des Fensters gibt
+            //! Legt fest, ob es eine Maximale Breite des Fensters gibt
             static const __int64 MaxBr = 0x000800000;
-            // Legt fest, ob es eine Minimale Höhe des Fensters gibt
+            //! Legt fest, ob es eine Minimale Höhe des Fensters gibt
             static const __int64 MinHi = 0x001000000;
-            // Legt fest, ob es eine Maximale Höhe des Fensters gibt
+            //! Legt fest, ob es eine Maximale Höhe des Fensters gibt
             static const __int64 MaxHi = 0x002000000;
-            // Legt fest, ob es eine Minimale Breite des Körpers gibt
+            //! Legt fest, ob es eine Minimale Breite des Körpers gibt
             static const __int64 BodyMinBr = 0x004000000;
-            // Legt fest, ob es eine Maximale Breite des Körpers gibt
+            //! Legt fest, ob es eine Maximale Breite des Körpers gibt
             static const __int64 BodyMaxBr = 0x008000000;
-            // Legt fest, ob es eine Minimale Höhe des Körpers gibt
+            //! Legt fest, ob es eine Minimale Höhe des Körpers gibt
             static const __int64 BodyMinHi = 0x010000000;
-            // Legt fest, ob es eine Maximale Höhe des Körpers gibt
+            //! Legt fest, ob es eine Maximale Höhe des Körpers gibt
             static const __int64 BodyMaxHi = 0x020000000;
-            // Legt fest, ob eine ScrollBar am rechten Fensterrand erscheinen
-            // soll
+            //! Legt fest, ob eine ScrollBar am rechten Fensterrand erscheinen
+            //! soll
             static const __int64 VScroll = 0x040000000;
-            // Legt fest, ob eine ScrollBar am unteren Fensterrand erscheinen
-            // soll
+            //! Legt fest, ob eine ScrollBar am unteren Fensterrand erscheinen
+            //! soll
             static const __int64 HScroll = 0x080000000;
-            // Legt fest, ob die Mausereignisse auch noch von Zeichnungen
-            // hinter dem Fenster verarbeitet werden sollen
+            //! Legt fest, ob die Mausereignisse auch noch von Zeichnungen
+            //! hinter dem Fenster verarbeitet werden sollen
             static const __int64 METransparenz = 0x100000000;
-            // Legt fest, ob das Fenster einen Rahmen haben soll
+            //! Legt fest, ob das Fenster einen Rahmen haben soll
             static const __int64 Rahmen = 0x200000000;
-            // Legt fest, ob die linke Seite des Fensters fixiert ist wenn die
-            // größe änderbar ist
+            //! Legt fest, ob die linke Seite des Fensters fixiert ist wenn die
+            //! größe änderbar ist
             static const __int64 LeftPositionFixed = 0x400000000;
-            // Legt fest, ob die rechte Seite des Fensters fixiert ist wenn die
-            // größe änderbar ist
+            //! Legt fest, ob die rechte Seite des Fensters fixiert ist wenn die
+            //! größe änderbar ist
             static const __int64 RightPositionFixed = 0x800000000;
-            // Legt fest, ob die obere Seite des Fensters fixiert ist wenn die
-            // größe änderbar ist
+            //! Legt fest, ob die obere Seite des Fensters fixiert ist wenn die
+            //! größe änderbar ist
             static const __int64 TopPositionFixed = 0x1000000000;
-            // Legt fest, ob die untere Seite des Fensters fixiert ist wenn die
-            // größe änderbar ist
+            //! Legt fest, ob die untere Seite des Fensters fixiert ist wenn die
+            //! größe änderbar ist
             static const __int64 BottomPositionFixed = 0x2000000000;
-            // Legt fest, ob die Position und Größe des Titel Textfeldes unverändert bleiben soll
+            //! Legt fest, ob die Position und Größe des Titel Textfeldes unverändert bleiben soll
             static const __int64 CustomTitle = 0x4000000000;
-            // Vereint die Flags MinHö, MaxHö, MaxBr, MaxHö
+            //! Vereint die Flags MinHö, MaxHö, MaxBr, MaxHö
             static const __int64 min_max = MinHi | MaxHi | MaxBr | MaxHi;
-            // Vereint die Flags Körper_minBr, Körper_maxBr, Körper_minHö,
-            // Körper_maxBr
+            //! Vereint die Flags Körper_minBr, Körper_maxBr, Körper_minHö,
+            //! Körper_maxBr
             static const __int64 body_min_max
                 = BodyMinBr | BodyMaxBr | BodyMinHi | BodyMaxBr;
-            // Vereint die Flags VScroll, HScroll
+            //! Vereint die Flags VScroll, HScroll
             static const __int64 scroll = VScroll | HScroll;
-            // Vereint die Flags TitelHöheÄnderbar, HöheÄnderbar,
-            // BreiteÄnderbar, Beweglich
+            //! Vereint die Flags TitelHöheÄnderbar, HöheÄnderbar,
+            //! BreiteÄnderbar, Beweglich
             static const __int64 nichtfixiert = TitelHeightChangeable
                                               | HeightChangeable
                                               | BreiteChangeable | Beweglich;
 
-            // Vereint die Flags Sichtbar, Erlaubt, Rahmen, Titel,
-            // TitelBuffered, Schließbar, SchließHBild, SchließKlickBuffer,
-            // Beweglich
+            //! Vereint die Flags Sichtbar, Erlaubt, Rahmen, Titel,
+            //! TitelBuffered, Schließbar, SchließHBild, SchließKlickBuffer,
+            //! Beweglich
             static const __int64 normal
                 = Sichtbar | Erlaubt | Rahmen | Titel | TitelBuffered | Closable
                 | ClosingHBild | ClosingKlickBuffer | Beweglich
@@ -595,7 +595,7 @@ namespace Framework
         //! Fügt dem Fenster eine Zeichnung hinzu
         //! \param obj Die Zeichnung
         DLLEXPORT virtual void addMember(Zeichnung* obj);
-        // sets the position of a member to index. This changes the order of rendering and the order input events are processed
+        //! sets the position of a member to index. This changes the order of rendering and the order input events are processed
         DLLEXPORT void setMemberIndex(Zeichnung* zMember, int index);
         //! Entfernt eine Zeichnung aus dem Fenster
         //! \param zObj Die Zeichnung (ohne erhöhten reference Counter)

+ 20 - 20
Fortschritt.h

@@ -20,39 +20,39 @@ namespace Framework
         class Style : public ZeichnungHintergrund::Style
         {
         public:
-            // Legt fest, ob eine Prozentangebe gezechnet wird
+            //! Legt fest, ob eine Prozentangebe gezechnet wird
             static const __int64 Prozent = 0x001000;
-            // Legt fest, ob die Aktionsschritte gezeichnet werden
+            //! Legt fest, ob die Aktionsschritte gezeichnet werden
             static const __int64 Aktionen = 0x01000000;
-            // Legt fest, ob der vom fortschritt erfasste Teil des Balkens einen
-            // eigenen Rahmen hat
+            //! Legt fest, ob der vom fortschritt erfasste Teil des Balkens einen
+            //! eigenen Rahmen hat
             static const __int64 FRahmen = 0x002000;
-            // Legt fest, ob der vom fortschritt erfasste Teil des Balkens eine
-            // eigene Hintergrund Farbe hat
+            //! Legt fest, ob der vom fortschritt erfasste Teil des Balkens eine
+            //! eigene Hintergrund Farbe hat
             static const __int64 FFarbe = 0x004000;
-            // Legt fest, ob der vom fortschritt erfasste Teil des Balkens ein
-            // eigenes Hintergrund Bild hat
+            //! Legt fest, ob der vom fortschritt erfasste Teil des Balkens ein
+            //! eigenes Hintergrund Bild hat
             static const __int64 FBild = 0x008000;
-            // Legt fest, ob der vom fortschritt erfasste Teil des Balkens zum
-            // zeichnen seines Hintergrundes alpha blending verwendet
+            //! Legt fest, ob der vom fortschritt erfasste Teil des Balkens zum
+            //! zeichnen seines Hintergrundes alpha blending verwendet
             static const __int64 FAlpha = 0x10000;
-            // Legt fest, ob der vom fortschritt erfasste Teil des Balkens einen
-            // eigenen Frbübergang hat
+            //! Legt fest, ob der vom fortschritt erfasste Teil des Balkens einen
+            //! eigenen Frbübergang hat
             static const __int64 FBuffered = 0x20000;
 
-            // Legt fest, ob sich der Fortschritt von lenks nach rechts
-            // ausbreitet
+            //! Legt fest, ob sich der Fortschritt von lenks nach rechts
+            //! ausbreitet
             static const __int64 L_R = 0x0100000;
-            // Legt fest, ob sich der Fortschritt von rechts nach links
-            // ausbreitet
+            //! Legt fest, ob sich der Fortschritt von rechts nach links
+            //! ausbreitet
             static const __int64 R_L = 0x0200000;
-            // Legt fest, ob sich der Fortschritt von unten nach oben ausbreitet
+            //! Legt fest, ob sich der Fortschritt von unten nach oben ausbreitet
             static const __int64 U_O = 0x0400000;
-            // Legt fest, ob sich der Fortschritt von oben nach unten ausbreitet
+            //! Legt fest, ob sich der Fortschritt von oben nach unten ausbreitet
             static const __int64 O_U = 0x0800000;
 
-            // Vereint die Flags Sichtbar, Rahmen, Hintergrund, HBild, FRahmen,
-            // FBild, L_R, Prozent
+            //! Vereint die Flags Sichtbar, Rahmen, Hintergrund, HBild, FRahmen,
+            //! FBild, L_R, Prozent
             static const __int64 normal = Sichtbar | Rahmen | Hintergrund
                                         | HBild | FRahmen | FBild | L_R
                                         | Prozent | Aktionen | HBildScale;

+ 10 - 10
GraphicsApi.h

@@ -121,18 +121,18 @@ namespace Framework
         DLLEXPORT Vec2<int> getBackBufferSize() const;
         DLLEXPORT bool isFullScreen() const;
         DLLEXPORT virtual Bild* zUIRenderBild() const = 0;
-        // returns the specified model without increased reference counter
+        //! returns the specified model without increased reference counter
         DLLEXPORT virtual Model3DData* zModel(const char* name);
-        // returns the specified model with increased reference counter
+        //! returns the specified model with increased reference counter
         DLLEXPORT virtual Model3DData* getModel(const char* name);
-        // creates a new empty Model3DData object if the model does not exist
-        // yet
+        //! creates a new empty Model3DData object if the model does not exist
+        //! yet
         DLLEXPORT virtual Model3DData* createModel(const char* name);
-        // check if a model exists
+        //! check if a model exists
         DLLEXPORT virtual bool hasModel(const char* name);
-        // creates a StructuredBuffer that is stored in the GPU memory and can
-        // be used as a shader resource
-        // \param eSize the size of one element of the buffer in bytes
+        //! creates a StructuredBuffer that is stored in the GPU memory and can
+        //! be used as a shader resource
+        //! \param eSize the size of one element of the buffer in bytes
         DLLEXPORT virtual DXBuffer* createStructuredBuffer(int eSize) = 0;
     };
 
@@ -282,8 +282,8 @@ namespace Framework
         DLLEXPORT void beginFrame(
             bool fill2D, bool fill3D, int fillColor) override;
         DLLEXPORT void renderKamera(Kam3D* zKamera) override;
-        // TODO: DLLEXPORT void renderKamera( Kam3D* zKamera, Textur* zTarget )
-        // override;
+        //! TODO: DLLEXPORT void renderKamera( Kam3D* zKamera, Textur* zTarget )
+        //! override;
         DLLEXPORT void presentFrame() override;
         DLLEXPORT Textur* createOrGetTextur(const char* name, Bild* b) override;
         DLLEXPORT Bild* zUIRenderBild() const override;

+ 23 - 23
Liste.h

@@ -25,42 +25,42 @@ namespace Framework
         class Style : public ZeichnungHintergrund::Style
         {
         public:
-            // Legt fest, ob die Einträge der Liste einen Rahmen haben
+            //! Legt fest, ob die Einträge der Liste einen Rahmen haben
             static const __int64 FeldRahmen = 0x0001000;
-            // Legt fest, ob die Einträge einen Hintergrund haben
+            //! Legt fest, ob die Einträge einen Hintergrund haben
             static const __int64 FeldHintergrund = 0x0002000;
-            // Legt fest, ob die Einträge ein Hintergrund Bild haben
+            //! Legt fest, ob die Einträge ein Hintergrund Bild haben
             static const __int64 FeldHBild = 0x0004000;
-            // Legt fest, ob beim zeichnen der Eintrag Hintergründe alpha
-            // blending verwendet werden soll
+            //! Legt fest, ob beim zeichnen der Eintrag Hintergründe alpha
+            //! blending verwendet werden soll
             static const __int64 FeldHAlpha = 0x0008000;
-            // Legt fest, ob die Einträge einen Farbübergang besitzen
+            //! Legt fest, ob die Einträge einen Farbübergang besitzen
             static const __int64 FeldBuffer = 0x0010000;
-            // Legt fest, ob die ausgewählten Einträge einen Hintergrund haben
+            //! Legt fest, ob die ausgewählten Einträge einen Hintergrund haben
             static const __int64 AuswahlHintergrund = 0x0020000;
-            // Legt fest, ob die ausgewählten einträge ein Bild als Hintergrund
-            // haben
+            //! Legt fest, ob die ausgewählten einträge ein Bild als Hintergrund
+            //! haben
             static const __int64 AuswahlHBild = 0x0040000;
-            // Legt fest, ob für das Zeichnen der Hintergründe der ausgewählten
-            // Einträge alpha blending verwendet wird
+            //! Legt fest, ob für das Zeichnen der Hintergründe der ausgewählten
+            //! Einträge alpha blending verwendet wird
             static const __int64 AuswahlHAlpha = 0x0080000;
-            // Legt fest, ob die ausgewählten Einträge einen Farbübergang
-            // besitzen
+            //! Legt fest, ob die ausgewählten Einträge einen Farbübergang
+            //! besitzen
             static const __int64 AuswahlBuffer = 0x0100000;
-            // Legt fest, ob die ausgewählten Einträge einen Rahmen besitzen
+            //! Legt fest, ob die ausgewählten Einträge einen Rahmen besitzen
             static const __int64 AuswahlRahmen = 0x0200000;
-            // Legt fest, ob jeder Eintrag seine eigenen Hintergrund,
-            // Farbübergang und Rahmen hat, fals er ausgewählt ist
+            //! Legt fest, ob jeder Eintrag seine eigenen Hintergrund,
+            //! Farbübergang und Rahmen hat, fals er ausgewählt ist
             static const __int64 MultiStyled = 0x0400000;
-            // Legt fest, das mehrere Einträge gleichzeitig ausgewählt sein
-            // können
+            //! Legt fest, das mehrere Einträge gleichzeitig ausgewählt sein
+            //! können
             static const __int64 MultiSelect = 0x0800000;
-            // Legt fest, ob ein bestimmter Eintrag ausgewählt ist, falls
-            // MultiSelect gesetzt wurde.
+            //! Legt fest, ob ein bestimmter Eintrag ausgewählt ist, falls
+            //! MultiSelect gesetzt wurde.
             static const __int64 Selected = 0x1000000;
 
-            // Vereint die Flags Sichtbar, Erlaubt, Rahmen, FeldHAlpha,
-            // FeldHintergrund, FeldRahmen, AuswahlBuffer, AuswahlRahmen
+            //! Vereint die Flags Sichtbar, Erlaubt, Rahmen, FeldHAlpha,
+            //! FeldHintergrund, FeldRahmen, AuswahlBuffer, AuswahlRahmen
             static const __int64 Normal
                 = Sichtbar | Erlaubt | Rahmen | FeldHAlpha | FeldHintergrund
                 | FeldRahmen | AuswahlBuffer | AuswahlRahmen;
@@ -334,7 +334,7 @@ namespace Framework
         class Style : public ZeichnungHintergrund::Style
         {
         public:
-            // draws a seperation line between the entries
+            //! draws a seperation line between the entries
             static const __int64 EntrySeperator = 0x0001000;
             //! Vereint die Flags Sichtbar, Erlaubt,
             //! Rahmen, Hintergrund

+ 3 - 3
Model3D.h

@@ -33,8 +33,8 @@ namespace Framework
         int id;
 
     public:
-        // Constructor
-        // \param id the id of the bone
+        //! Constructor
+        //! \param id the id of the bone
         DLLEXPORT Bone(int id);
         //! Destructor
         DLLEXPORT ~Bone();
@@ -182,7 +182,7 @@ namespace Framework
             DXBuffer* dxVertexBuffer, DXBuffer* dxIndexBuffer, int id);
         //! Destruktor
         DLLEXPORT ~Model3DData();
-        // updates the DX Buffer gpu memory if changed
+        //! updates the DX Buffer gpu memory if changed
         DLLEXPORT void updateGPUMemory();
         //! Löscht alle Model daten
         DLLEXPORT void clearModel();

+ 1 - 1
Text.h

@@ -361,7 +361,7 @@ namespace Framework
         //!  p1: Die Startposition des Textabschnittes (Der Textabschnitt geht
         //!  bis ans Ende des Textes)
         DLLEXPORT Text* getTeilText(int p) const;
-        // berechnet den Hash code des textes
+        //! berechnet den Hash code des textes
         DLLEXPORT int hashCode() const;
         //! Hängt eine Zahl ans Ende des Textes an
         DLLEXPORT Text& operator+=(const int num);

+ 15 - 15
TextFeld.h

@@ -85,21 +85,21 @@ namespace Framework
         class Style : public ZeichnungHintergrund::Style
         {
         public:
-            // Wenn dieser Flag nicht gesetzt wird, werden alle Zeilenumbrüche
-            // automatisch aus dem Text entfernt
+            //! Wenn dieser Flag nicht gesetzt wird, werden alle Zeilenumbrüche
+            //! automatisch aus dem Text entfernt
             static const __int64 Mehrzeilig = 0x001000;
-            // Wenn dieser Flag gesetzt wird, wird der Text genau in der
-            // horizontaen Mitte des Feldes plaziert
+            //! Wenn dieser Flag gesetzt wird, wird der Text genau in der
+            //! horizontaen Mitte des Feldes plaziert
             static const __int64 HCenter = 0x002000;
-            // Wenn dieser Flag gesetzt wird, wird der Text genau in der
-            // vertikalen Mitte des Feldes plaziert
+            //! Wenn dieser Flag gesetzt wird, wird der Text genau in der
+            //! vertikalen Mitte des Feldes plaziert
             static const __int64 VCenter = 0x004000;
-            // Wenn dieser Flag gesetzt wird, kann der Text durch den Nutzer
-            // bearbeitet werden
+            //! Wenn dieser Flag gesetzt wird, kann der Text durch den Nutzer
+            //! bearbeitet werden
             static const __int64 Editierbar = 0x2000000;
-            // Fügt beim rendern automatisch zeilenumbrüche in den Text ein, so
-            // dass die Breite des Textfeldes nicht überschritten wird. Der Text
-            // wird dabei nicht verändert. Benötigt Style Mehrzeilig
+            //! Fügt beim rendern automatisch zeilenumbrüche in den Text ein, so
+            //! dass die Breite des Textfeldes nicht überschritten wird. Der Text
+            //! wird dabei nicht verändert. Benötigt Style Mehrzeilig
             static const __int64 AutoLineBreak = 0x4000000;
 
             //! Vereint die Flags HCenter und VCenter
@@ -183,8 +183,8 @@ namespace Framework
         //! der Text mit zeilenumbrüchen
         DLLEXPORT Text addLineBreaksToText(
             const char* txt, const char* spacing = "") const;
-        // setzt eine Zeichenfolge die mit dem style AutoLineBreak nach jedem
-        // eingefügten Zeilenumbruch eingefügt wird
+        //! setzt eine Zeichenfolge die mit dem style AutoLineBreak nach jedem
+        //! eingefügten Zeilenumbruch eingefügt wird
         DLLEXPORT void setAutoLineBreakSpacing(const char* spacing);
         //! Setzt den Style eines Textabschnittes
         //! \param begin die startposition des Abschnittes
@@ -364,8 +364,8 @@ namespace Framework
         //! Gibt den Style eines bestimmten zeichens zurück
         //! \param index Der index des Zeichensf
         DLLEXPORT TextStyle getTextStyle(int index) const;
-        // gibt die Zeichenkette zurück, die bei Verwendung des Styles
-        // AutoLineBreak nach jedem Zeilenumbruch eingefügt wird
+        //! gibt die Zeichenkette zurück, die bei Verwendung des Styles
+        //! AutoLineBreak nach jedem Zeilenumbruch eingefügt wird
         DLLEXPORT Text getAutoLineBreakSpacing() const;
         //! Erzeugt eine Komplette Kopie des Textfeldes, welches ohne
         //! auswirkungen verändert werden kann

+ 2 - 2
Thread.h

@@ -60,9 +60,9 @@ namespace Framework
         DLLEXPORT void setSystemHandlePointer(pthread_t* ths);
         //! Gibt ein Handle auf den Thread zurück
         DLLEXPORT pthread_t getThreadHandle() const;
-        // set the name of the thread
+        //! set the name of the thread
         DLLEXPORT void setName(const char* name);
-        // get the name of the thread
+        //! get the name of the thread
         DLLEXPORT const char* getName() const;
 
     private:

+ 1 - 1
XML.h

@@ -207,7 +207,7 @@ namespace Framework
             DLLEXPORT bool exists() const;
             //! gibt die anzahl der ausgewählten elemente zurück
             DLLEXPORT int getSize() const;
-            // assignment operator
+            //! assignment operator
             DLLEXPORT Editor& operator=(const Editor& e);
         };
     } // namespace XML

+ 15 - 15
Zeichnung.h

@@ -263,7 +263,7 @@ namespace Framework
         //! \param style Die Styles, die geprüft werden sollen
         //! \return 1, falls alle Styles in style nicht gesetzt wurden
         DLLEXPORT bool hatStyleNicht(__int64 style) const;
-        // returns all currently active styles
+        //! returns all currently active styles
         DLLEXPORT __int64 getStyles() const;
         //! Kopiert die Komplette Zeichnung, so dass sie ohne Effekt auf das
         //! Original verändert werden kann
@@ -278,27 +278,27 @@ namespace Framework
         class Style : public Zeichnung::Style
         {
         public:
-            // Wenn dieser Flag gesetzt wird, bekommt die Zeichnugn einen Rahmen
+            //! Wenn dieser Flag gesetzt wird, bekommt die Zeichnugn einen Rahmen
             static const __int64 Rahmen = 0x00010;
-            // Wenn dieser Flag gesetzt wird, bekommt die Zeichnung einen
-            // Hintergrund
+            //! Wenn dieser Flag gesetzt wird, bekommt die Zeichnung einen
+            //! Hintergrund
             static const __int64 Hintergrund = 0x00020;
-            // Wenn dieser Flag gesetzt wird, wird der Hintergrund durchsichtig.
-            // Benötigt Flag Hintergrund
+            //! Wenn dieser Flag gesetzt wird, wird der Hintergrund durchsichtig.
+            //! Benötigt Flag Hintergrund
             static const __int64 HAlpha = 0x00040;
-            // Wenn dieser Flag gesetzt wird, wird ein Bild als hintergrund
-            // verwendet. Benötigt Flag Hintergrund
+            //! Wenn dieser Flag gesetzt wird, wird ein Bild als hintergrund
+            //! verwendet. Benötigt Flag Hintergrund
             static const __int64 HBild = 0x00080;
-            // Wenn dieser Flag gesetzt wird, Erscheint ein Farbübergang als
-            // Rahmen
+            //! Wenn dieser Flag gesetzt wird, Erscheint ein Farbübergang als
+            //! Rahmen
             static const __int64 Buffered = 0x00100;
-            // Wenn dieser Flag gesetzt wird, erscheint eine Scrollbar am
-            // rechten Rand
+            //! Wenn dieser Flag gesetzt wird, erscheint eine Scrollbar am
+            //! rechten Rand
             static const __int64 VScroll = 0x00200;
-            // Wenn dieser Flag gesetzt wird, erscheint eine Scrollbar am
-            // unteren Rand
+            //! Wenn dieser Flag gesetzt wird, erscheint eine Scrollbar am
+            //! unteren Rand
             static const __int64 HScroll = 0x00400;
-            // Wenn dieser Flag gesetzt wird, wird das Bild skaliert
+            //! Wenn dieser Flag gesetzt wird, wird das Bild skaliert
             static const __int64 HBildScale = 0x00800;
         };
 

+ 5 - 5
Zeit.h

@@ -23,21 +23,21 @@ namespace Framework
         int update();
 
     public:
-        // Erzeugt ein neues Uhrzeit Zeichnung mit den Standartwerten 00:00:00
+        //! Erzeugt ein neues Uhrzeit Zeichnung mit den Standartwerten 00:00:00
         DLLEXPORT Uhrzeit();
 
-        // Setzt die Uhrzeit durch kopieren.
+        //! Setzt die Uhrzeit durch kopieren.
         //! \param zeit Aus diesem Zeichnung werden die Werte für Stunde, Minute
         //! und Sekunde kopiert.
         DLLEXPORT int setUhrzeit(Uhrzeit* zeit);
-        // Setzt die Uhrzeit.
+        //! Setzt die Uhrzeit.
         //! \param stunde Die Stunde der neuen Uhrzeit.
         //! \param minute Die Minute der neuen Uhrzeit.
         //! \param sekunde Die Sekunde der neuen Uhrzeit.
         //! \return Die Anzahl übriger Tage.
         //! Beispiel: setUhrzeit( 30, 30, 30 ); return: 1, gespeichert: 6:30:30
         DLLEXPORT int setUhrzeit(int stunde, int minute, int sekunde);
-        // Setzt die Uhrzeit.
+        //! Setzt die Uhrzeit.
         //! \param format Eine Zeichenfolge, die bestimmt in welcher Form die
         //! Uhrzeit in (zeit) vorliegt. h=Stunde, i=Minute,s=Sekunde. \param
         //! zeit Eine Zeichenfolge die die neue Uhrzeit enthält. \return Die
@@ -45,7 +45,7 @@ namespace Framework
         //! Beispiel: setUhrzeit( "h:i:s", "30:30:00" ); return: 1, gespeichert:
         //! 6:30:00
         DLLEXPORT int setUhrzeit(const char* format, const char* zeit);
-        // Setzt die Uhrzeit.
+        //! Setzt die Uhrzeit.
         //! \param format Eine Zeichenfolge, die bestimmt in welcher Form die
         //! Uhrzeit in (zeit) vorliegt. h=Stunde, i=Minute,s=Sekunde. \param
         //! zeit Ein Text Zeichnung, dass die neue Uhrzeit enthält. \return Die