path: root/doc
diff options
authorMarcelo Lira <marcelo.lira@openbossa.org>2010-11-22 19:38:12 -0300
committerHugo Parente Lima <hugo.pl@gmail.com>2012-03-09 19:10:12 -0300
commit840f54bb66ed4aae3b1659c518a9af83fc6a5f76 (patch)
treeb9137d6e0aaecff73e57c716219f13749a8898f4 /doc
parent991f3c6902f1fb77bd952b3168f006e39126db05 (diff)
Updated documentation for the 'remove' attribute of the 'modified-field' tag.
Reviewed by Lauro Moura <lauro.neto@openbossa.org> Reviewed by Renato Ara├║jo <renato.filho@openbossa.org>
Diffstat (limited to 'doc')
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/typesystem_manipulating_objects.rst b/doc/typesystem_manipulating_objects.rst
index 4c812113..2838c95e 100644
--- a/doc/typesystem_manipulating_objects.rst
+++ b/doc/typesystem_manipulating_objects.rst
@@ -53,6 +53,9 @@ modify-field
The ``name`` attribute is the name of the field, the *optional* ``write``
and ``read`` attributes specify the field's access privileges in the target
language API (both are set to true by default).
+ The ``remove`` attribute is an *optional* attribute, which can mark the field
+ to be discarded on generation; it has the same purpose of the deprecated tag
+ :ref:`remove`.
.. _modify-function: