diff options
| author | Andreas Stöckel <astoecke@techfak.uni-bielefeld.de> | 2015-01-13 23:43:11 +0100 |
|---|---|---|
| committer | Andreas Stöckel <astoecke@techfak.uni-bielefeld.de> | 2015-01-13 23:43:11 +0100 |
| commit | 17420a49f5e20454462b1b1a2e5a0140cc984dcc (patch) | |
| tree | 76976a9a759f55658cc0ca202ae6c686d12c8e89 /src/core/model/Domain.hpp | |
| parent | 3311fa10fdd841a1b2d6146b848166f3da6e5487 (diff) | |
Fixed doxygen warnings
Diffstat (limited to 'src/core/model/Domain.hpp')
| -rw-r--r-- | src/core/model/Domain.hpp | 30 |
1 files changed, 20 insertions, 10 deletions
diff --git a/src/core/model/Domain.hpp b/src/core/model/Domain.hpp index 4b35fd4..23a55f3 100644 --- a/src/core/model/Domain.hpp +++ b/src/core/model/Domain.hpp @@ -233,15 +233,17 @@ class Domain; * As an example consider the "paragraph" StructuredClass, which might allow * the actual text content. Here is the according XML: * - * <struct name="paragraph" transparent="true" role="paragraph"> - * <fields> - * <field> - * <children> - * <child name="book.text"/> - * </children> - * </field> - * </fields> - * </struct> + * \code{*.xml} + * <struct name="paragraph" transparent="true" role="paragraph"> + * <fields> + * <field> + * <children> + * <child name="book.text"/> + * </children> + * </field> + * </fields> + * </struct> + * \endcode * * Accordingly the primitiveType field of a FieldDescriptor may only be * defined if the type is set to "PRIMITIVE". If the type is something else @@ -372,9 +374,11 @@ public: * explained as the difference between node attributes and node children. * Consider the XML * + * \code{*.xml} * <A key="value"> * <key>value</key> * </A> + * \endcode * * key="value" inside the A-node would be an attribute, while <key>value</key> * would be a primitive field. While equivalent in XML the semantics are @@ -451,6 +455,7 @@ typedef RangeSet<size_t> Cardinality; * defining itself as a viable child in one existing field. Consider the * example of the "heading" domain from the header documentation again: * + * \code{*.xml} * <domain name="headings"> * <head> * <import rel="domain" src="book.oxm"/> @@ -468,6 +473,7 @@ typedef RangeSet<size_t> Cardinality; * </fields> * </structs> * </domain> + * \endcode * * The "parent" construct allows to "invade" another domain. * @@ -481,19 +487,23 @@ typedef RangeSet<size_t> Cardinality; * If we go back to our example a user would (without transparency) have to * explicitly declare: * + * \code{*.xml} * <book> * <section> * <paragraph>Text.</paragraph> * </section> * </book> + * \endcode * * But in our mind the document - + * + * \code{*.xml} * <book> * <section> * Text. * </section> * </book> + * \endcode * * Is already sufficiently specific. We can infer that a paragraph should be * wrapped around "Text.". Therefore we set the 'transparent' flag of the |