Browse Source

Bessere dokumentation

Kolja Strohm 4 years ago
parent
commit
18a80b6f3c
3 changed files with 20 additions and 18 deletions
  1. 8 8
      TextFeld.h
  2. 11 9
      UIMLView.h
  3. 1 1
      XML.h

+ 8 - 8
TextFeld.h

@@ -133,14 +133,14 @@ namespace Framework
         DLLEXPORT void setText( const char *txt );
         //! setzt den Text mit styles
         //! \param txt der Text
-        //! \param format \x1: aktiviert unterschtrich
-        //!          \x2\xY: setzt die schriftgröße auf y für den folgenden text
-        //!          \x3\xA\xR\xG\xB: setzt die schriftfarbe auf ARGB
-        //!          \x4\xA\xR\xG\xB: setzt die farbe des ausgewählten textes
-        //!          \x5\xA\xR\xG\xB: setzt die hintergrundfarbe des ausgewählten textes
-        //!          \x6\xY: setzt text renderer index auf y
-        //!          \x7: deaktiviert unterschtrich
-        //!          \x8\xA\xB\xC\xD: set interact param to ABCD
+        //! \param format - \\x1: aktiviert unterschtrich
+        //!               - \\x2\\xY: setzt die schriftgröße auf y für den folgenden text
+        //!               - \\x3\\xA\\xR\\xG\\xB: setzt die schriftfarbe auf ARGB
+        //!               - \\x4\\xA\\xR\\xG\\xB: setzt die farbe des ausgewählten textes
+        //!               - \\x5\\xA\\xR\\xG\\xB: setzt die hintergrundfarbe des ausgewählten textes
+        //!               - \\x6\\xY: setzt text renderer index auf y
+        //!               - \\x7: deaktiviert unterschtrich
+        //!               - \\x8\\xA\\xB\\xC\\xD: set interact param to ABCD
         DLLEXPORT void setFormattedText( const char *txt );
         //! fügt zeilenumbrüche so ein, dass der text nicht die breite des textfeldes überschreitet
         //! \param spacing ein text, der direkt nach jedem eingefügten Zeilenumbruch eingefügt wird

+ 11 - 9
UIMLView.h

@@ -60,15 +60,17 @@ namespace Framework
          - text-align-vertical (textfield, text, textarea)
 
       example:
-        \<view\>
-          \<textfield id="element_at_top_left" align-left="start", align-top="start", margin-left="5", margin-top="5" width="90%" height="30"/\>
-          \<table id="element_below_textfield" align-left="start", aliign-top="element_at_top_left", margin-left="5", margin-top="5" width="90%" height="300"\>
-            \<tr\>
-              \<button id="a_button_in_a_table"/\>
-              \<textfield id="a_textfield_in_a_table"/\>
-            \</tr\>
-          \</table\>
-        \</view\>
+        \code
+        <view>
+          <textfield id="element_at_top_left" align-left="start", align-top="start", margin-left="5", margin-top="5" width="90%" height="30"/>
+          <table id="element_below_textfield" align-left="start", aliign-top="element_at_top_left", margin-left="5", margin-top="5" width="90%" height="300">
+            <tr>
+              <button id="a_button_in_a_table"/>
+              <textfield id="a_textfield_in_a_table"/>
+            </tr>
+          </table>
+        </view>
+        \endcode
     */
     class UIMLView : public ZeichnungHintergrund
     {

+ 1 - 1
XML.h

@@ -11,7 +11,7 @@ namespace Framework
     {
         class Editor;
 
-        //! Ein XML element der Form \code \<name attribut1 attribut2="value"\>text oder childs\</name\>
+        //! Ein XML element der Form \code <name attribut1 attribut2="value">text oder childs</name> \endcode
         class Element
         {
         private: