summaryrefslogtreecommitdiff
path: root/src/core/model/Document.hpp
diff options
context:
space:
mode:
authorAndreas Stöckel <astoecke@techfak.uni-bielefeld.de>2015-01-11 23:57:57 +0100
committerAndreas Stöckel <astoecke@techfak.uni-bielefeld.de>2015-01-11 23:57:57 +0100
commit94828bc348c4aab0d91da6499c30b26c2ef8f8e2 (patch)
treed027577fc09662b41129e04f392c4d283b7aca4a /src/core/model/Document.hpp
parente83d0c87c27aa72f44b882b115b7522c3afc6180 (diff)
Silenced doxygen warnings
Diffstat (limited to 'src/core/model/Document.hpp')
-rw-r--r--src/core/model/Document.hpp8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/core/model/Document.hpp b/src/core/model/Document.hpp
index e27b577..a18e389 100644
--- a/src/core/model/Document.hpp
+++ b/src/core/model/Document.hpp
@@ -34,6 +34,7 @@
*
* Consider this XML representation of a document using the "book" domain:
*
+ * \code{.xml}
* <doc>
* <head>
* <import rel="domain" src="book_domain.oxm"/>
@@ -59,6 +60,7 @@
* </chapter>
* </book>
* </doc>
+ * \endcode
*
* As can be seen the StructureEntities inherently follow a tree structure that
* is restricted by the implicit context free grammar of the "book" Domain
@@ -70,12 +72,16 @@
* overlapping annotations and provides a more intuitive (and semantically
* sound) handling of such span-like concepts. So the
*
+ * \code{.xml}
* <em>content</em>
+ * \endcode
*
* is implicitly expanded to:
*
+ * \code{.xml}
* <a id="1"/>content<a id="2"/>
* <emphasized start="1" end="2"/>
+ * \endcode
*
* Note that the place of an AnnotationEntity within the XML above is not
* strictly defined. It might as well be placed as a child of the "book" node.
@@ -88,11 +94,13 @@
*
* is implicitly expanded using transparency to:
*
+ * \code{.xml}
* <paragraph>
* <text>
* Here we might find the actual section content.
* </text>
* </paragraph>
+ * \endcode
*
* @author Benjamin Paaßen (bpaassen@techfak.uni-bielefeld.de)
*/