You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by ca...@apache.org on 2020/08/14 09:57:27 UTC
[royale-asjs] branch develop updated: jewel-drawer: fix some docs
This is an automated email from the ASF dual-hosted git repository.
carlosrovira pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-asjs.git
The following commit(s) were added to refs/heads/develop by this push:
new 89f3a36 jewel-drawer: fix some docs
89f3a36 is described below
commit 89f3a366554db57ca13f5353cb8aa0bf1bb1ff18
Author: Carlos Rovira <ca...@apache.org>
AuthorDate: Fri Aug 14 11:57:14 2020 +0200
jewel-drawer: fix some docs
---
.../Jewel/src/main/royale/org/apache/royale/jewel/Drawer.as | 13 +++++++------
.../royale/jewel/supportClasses/drawer/DrawerContent.as | 2 +-
.../royale/jewel/supportClasses/drawer/DrawerFooter.as | 2 +-
.../royale/jewel/supportClasses/drawer/DrawerHeader.as | 4 ++--
4 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Drawer.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Drawer.as
index f463c7c..4162f2d 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Drawer.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/Drawer.as
@@ -29,16 +29,17 @@ package org.apache.royale.jewel
/**
* The Drawer class is a container component used for navigation
- * can be opened with the menu icon.
+ * that can be opened with the menu icon, or be always visible. It use
+ * to be positioned at the left (or right) side of the application screen.
*
* It can be used in float or fixed modes.
*
- * float make the drawer appear over the screen without make anything change size
- * and click outside the drawer will hide it. Usually clicking in some navigation option
- * will hide it as well.
+ * float make the drawer appear over the screen without make any other application
+ * elements change size. Clicking outside the drawer will hide it. Usually clicking
+ * in some navigation option will hide it as well.
*
- * fixed will need some place and make the other content shrink. click on navigation option
- * in the drawer usually doesn't hide it.
+ * fixed will need some place and make the other application content shrink. Clicking
+ * on any navigation option in the drawer usually doesn't hide it.
*
* @langversion 3.0
* @playerversion Flash 10.2
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerContent.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerContent.as
index f9c2e9f..9a7d533 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerContent.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerContent.as
@@ -26,7 +26,7 @@ package org.apache.royale.jewel.supportClasses.drawer
import org.apache.royale.jewel.Group;
/**
- * The DrawerContent class is a Container component mainly used in Drawer to hold
+ * The DrawerContent class is a container component used in a Drawer to hold
* content like navigation, icons, or text.
*
* @langversion 3.0
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerFooter.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerFooter.as
index 0f76927..df1d17b 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerFooter.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerFooter.as
@@ -21,7 +21,7 @@ package org.apache.royale.jewel.supportClasses.drawer
import org.apache.royale.jewel.supportClasses.bar.BarRow;
/**
- * The DrawerFooter class is a Bar component to use as the last content in a Drawer.
+ * The DrawerFooter class is a BarRow component to use as the last content in a Drawer.
*
* The styling of this component is similar to the FooterBar.
*
diff --git a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerHeader.as b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerHeader.as
index 5b6d444..1eeaf7e 100644
--- a/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerHeader.as
+++ b/frameworks/projects/Jewel/src/main/royale/org/apache/royale/jewel/supportClasses/drawer/DrawerHeader.as
@@ -26,8 +26,8 @@ package org.apache.royale.jewel.supportClasses.drawer
import org.apache.royale.jewel.Group;
/**
- * The DrawerHeader class is a Container component to hold Drawer Header
- * content, for example a title or an Image icon logo
+ * The DrawerHeader class is a container component to hold drawer header
+ * content, like a title or an image icon logo
*
* @langversion 3.0
* @playerversion Flash 10.2