summaryrefslogtreecommitdiff
path: root/reference/csharp/snippets/README
blob: bab98f4ca88e7e94fa95e7d40515e9b27b584159 (plain) (blame)
1
2
3
4
5
6
7
8
9
Place code snippets in this folder.
If the file name matches a class name (like Efl.Ui.Win) or a property name (like Efl.Ui.Win.FocusHighlightEnabled)
the mono documentation generator (DocFX) will pick up the content of the file and embed it.
Two file formats are supported:
- Plain code (files with .cs extension): Code snippets are copied into the documentation inside <example> and <code>
  tags.
- XML text (files with .xml extension): This allows including explanatory text besides the code snippets, but the file
  must include the ESCAPED \<example\> and \<code\> tags. Escaping is accomplished by adding a backslash in front of
  angle brackets. Quotes must be escaped too: \"