Wiki page eo-classes.md changed with summary [Added documentation note] by Xavi Artigas

This commit is contained in:
Xavi Artigas 2017-11-23 04:19:50 -08:00 committed by apache
parent 0a8f5ad127
commit 8cbc3dfbf9
1 changed files with 3 additions and 0 deletions

View File

@ -44,6 +44,9 @@ In summary, for each new class you create you must:
The rest of the tutorial shows a practical example which will illustrate this procedure.
> **NOTE:**
> Eolian files can also contain **documentation** which will be transferred to the generated headers files in [Doxygen](http://doxygen.org) format. For an in-depth description of the Eolian documentation process, see the [Eolian Documentation Guide](/contrib/docs/eo-guide.md). In summary, documentation is enclosed in double square brackets ``[[ ... ]]`` but it will not be used in these tutorials.
## Step One: Creating a Simple Class Description ##
You will now create an Eolian file for a class named ``Example.Rectangle``. The file **must** be called ``examples_rectangle.eo``.