path: root/reference/csharp/snippets/README
diff options
Diffstat (limited to 'reference/csharp/snippets/README')
1 files changed, 9 insertions, 0 deletions
diff --git a/reference/csharp/snippets/README b/reference/csharp/snippets/README
new file mode 100644
index 00000000..bab98f4c
--- /dev/null
+++ b/reference/csharp/snippets/README
@@ -0,0 +1,9 @@
1Place code snippets in this folder.
2If the file name matches a class name (like Efl.Ui.Win) or a property name (like Efl.Ui.Win.FocusHighlightEnabled)
3the mono documentation generator (DocFX) will pick up the content of the file and embed it.
4Two file formats are supported:
5- Plain code (files with .cs extension): Code snippets are copied into the documentation inside <example> and <code>
6 tags.
7- XML text (files with .xml extension): This allows including explanatory text besides the code snippets, but the file
8 must include the ESCAPED \<example\> and \<code\> tags. Escaping is accomplished by adding a backslash in front of
9 angle brackets. Quotes must be escaped too: \"