Page MenuHomePhabricator

mono-docs: allow external examples embedded into the docs
Closed, ResolvedPublic

Description

Small code examples embedded in the docs would be nice, but they cannot be in the EO files, since Eolian is language-agnostic.
A possible solution is to have examples in a special folder (one folder per language), named after the class or method they exemplify, and have eolian_mono pick them up and embed their contents inside <example> and <code> tags the the .cs files.
DocFX correctly parses these tags and renders them nicely in the generated docs.
The same can be done later for C using gendoc.py or Doxygen.

segfaultxavi triaged this task as High priority.
segfaultxavi moved this task from Backlog to In progress on the efl: docs board.

D8592 added support for external examples but I won't close this task until examples for derived classes can be provided (that is, Efl.Ui.Button.Text instead of only Efl.IText.Text). This is still work in progress.