Browse Source

Escape xml comments

Kolja Strohm 4 years ago
parent
commit
6a7fc4a2ae
2 changed files with 54 additions and 55 deletions
  1. 53 54
      UIMLView.h
  2. 1 1
      XML.h

+ 53 - 54
UIMLView.h

@@ -5,60 +5,6 @@
 #include "Array.h"
 #include "UIInitialization.h"
 
-/*
-  KSG UIML Standart
-  possible XML elements: 
-    uimlview (the root element of uiml),
-    class (only as direct child of uimlview),
-    textfield, 
-    button, 
-    check, (KontrollKnopf)
-    text,
-    textarea,
-    table (allowed child elements: tr), 
-    tr (allowed child elements: textfield, button, table, text, textarea, frame),
-    frame (allowed child elements: textfield, button, table, text, textarea, frame).
-  possible global XML attributes: 
-    id (string should be unique), 
-    x (integer, optional % char at end), 
-    y (integer, optional % char at end), 
-    width (integer, optional % char at end), 
-    height (integer, optional % char at end), 
-    margin (integer, optional % char at end),
-    margin-left (integer, optional % char at end), 
-    margin-top (integer, optional % char at end), 
-    margin-right (integer, optional % char at end), 
-    margin-bottom (integer, optional % char at end),
-    align-left (string (id values of other elements or keywords: start, end)),
-    align-top (string (id values of other elements or keywords: start, end)),
-    align-bottom ((string (id values of other elements or keywords: start, end)),
-    align-right (string (id values of other elements or keywords: start, end)),
-    tooltip (string),
-    style (hex __int64),
-    class (string (id of class element))
-
-    attribute die sich gegenseitig ausschließen:
-    align-left / align-right
-    align-top / align-bottom
-
-  spezific attributes:
-     font-size (textfield, text, textarea, button)
-     text-align (textfield, text, textarea)
-     text-align-horizontal (textfield, text, textarea)
-     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>
-*/
-
 namespace Framework
 {
     class Text;
@@ -71,6 +17,59 @@ namespace Framework
         class Element;
     }
 
+    /**
+      KSG UIML Standart
+      possible XML elements:
+        - uimlview (the root element of uiml),
+        - class (only as direct child of uimlview),
+        - textfield,
+        - button,
+        - check, (KontrollKnopf)
+        - text,
+        - textarea,
+        - table (allowed child elements: tr),
+        - tr (allowed child elements: textfield, button, table, text, textarea, frame),
+        - frame (allowed child elements: textfield, button, table, text, textarea, frame).
+      possible global XML attributes:
+        - id (string should be unique),
+        - x (integer, optional % char at end),
+        - y (integer, optional % char at end),
+        - width (integer, optional % char at end),
+        - height (integer, optional % char at end),
+        - margin (integer, optional % char at end),
+        - margin-left (integer, optional % char at end),
+        - margin-top (integer, optional % char at end),
+        - margin-right (integer, optional % char at end),
+        - margin-bottom (integer, optional % char at end),
+        - align-left (string (id values of other elements or keywords: start, end)),
+        - align-top (string (id values of other elements or keywords: start, end)),
+        - align-bottom ((string (id values of other elements or keywords: start, end)),
+        - align-right (string (id values of other elements or keywords: start, end)),
+        - tooltip (string),
+        - style (hex __int64),
+        - class (string (id of class element))
+
+        attribute die sich gegenseitig ausschließen:
+        - align-left / align-right
+        - align-top / align-bottom
+
+      spezific attributes:
+         - font-size (textfield, text, textarea, button)
+         - text-align (textfield, text, textarea)
+         - text-align-horizontal (textfield, text, textarea)
+         - 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\>
+    */
     class UIMLView : public ZeichnungHintergrund
     {
     private:

+ 1 - 1
XML.h

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