summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-09-17 12:10:22 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-17 12:10:22 +0200
commitfd32510f350d8d445be7dcd174bff2561c763962 (patch)
tree6475fe4d9b9438096cee99c3cde4fdd24773f715
parent242ed076f3836f60bf84a32f2ded77879f3bd860 (diff)
mono snippets: Added README in the snippets folder
-rw-r--r--reference/csharp/snippets/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/reference/csharp/snippets/README b/reference/csharp/snippets/README
new file mode 100644
index 0000000..bab98f4
--- /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: \"