summaryrefslogtreecommitdiffstats
path: root/tests/rust/documentation.rs
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--tests/rust/documentation.rs21
1 files changed, 21 insertions, 0 deletions
diff --git a/tests/rust/documentation.rs b/tests/rust/documentation.rs
new file mode 100644
index 0000000..56da3c3
--- /dev/null
+++ b/tests/rust/documentation.rs
@@ -0,0 +1,21 @@
+/// The root of all evil.
+///
+/// But at least it contains some more documentation as someone would expect
+/// from a simple test case like this.
+///
+/// # Hint
+///
+/// Always ensure that everything is properly documented, even if you feel lazy.
+/// **Sometimes** it is also helpful to include some markdown formatting.
+///
+/// ////////////////////////////////////////////////////////////////////////////
+///
+/// Attention:
+///
+/// Rust is going to trim all leading `/` symbols. If you want to use them as a
+/// marker you need to add at least a single whitespace inbetween the tripple
+/// slash doc-comment marker and the rest.
+///
+#[no_mangle]
+pub extern "C" fn root() {
+}