Skip to content

Commit 15a21a2

Browse files
Few JavaDoc fixes
1 parent 3821fa5 commit 15a21a2

File tree

6 files changed

+22
-22
lines changed

6 files changed

+22
-22
lines changed

pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<groupId>com.github.gwtmaterialdesign</groupId>
66
<artifactId>gwt-material</artifactId>
7-
<version>1.3.3-SNAPSHOT</version>
7+
<version>1.3.3</version>
88

99
<name>Gwt Material Design</name>
1010
<description>A Material Design look and feel for GWT Apps plus Phonegap</description>
@@ -39,7 +39,7 @@
3939
<connection>scm:git:[email protected]:GwtMaterialDesign/gwt-material.git</connection>
4040
<developerConnection>scm:git:[email protected]:GwtMaterialDesign/gwt-material.git</developerConnection>
4141
<url>http://github.com/GwtMaterialDesign/gwt-material</url>
42-
<tag>HEAD</tag>
42+
<tag>gwt-material-1.3.3</tag>
4343
</scm>
4444

4545
<licenses>

src/main/java/gwt/material/design/client/ui/MaterialNavBar.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ public void addWidgetSideNav(final Widget item) {
108108

109109
/**
110110
* Adding progress indicator on the Nav Bar
111-
* @param isProgress
111+
* @param isProgress True to show the progress indicator False otherwise
112112
*/
113113
public void showProgress(boolean isProgress){
114114
if(isProgress){

src/main/java/gwt/material/design/client/ui/MaterialSlide.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ public void addSlide(Widget w){
5858

5959
/**
6060
* Initialize the slider when the widget is attached
61+
* @param className CSS class name
6162
*/
6263
public native void initializeSlider(String className)/*-{
6364
$wnd.jQuery(document).ready(function() {
@@ -73,7 +74,7 @@ public boolean isFullScreen() {
7374

7475
/**
7576
* Set the image slider if its fullscreen view
76-
* @param fullScreen
77+
* @param fullScreen True to fullscreen False otherwise
7778
*/
7879
public void setFullScreen(boolean fullScreen) {
7980
this.fullScreen = fullScreen;

src/main/java/gwt/material/design/client/ui/MaterialSlideItem.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public String getTitle() {
5656

5757
/**
5858
* Set the title caption of the slide
59-
* @param title
59+
* @param title Title
6060
*/
6161
public void setTitle(String title) {
6262
this.title = title;
@@ -69,7 +69,7 @@ public String getDescription() {
6969

7070
/**
7171
* Set the description caption of the slide
72-
* @param description
72+
* @param description Description
7373
*/
7474
public void setDescription(String description) {
7575
this.description = description;
@@ -82,7 +82,7 @@ public String getTextColor() {
8282

8383
/**
8484
* Set the text color of the title and description captions
85-
* @param textColor
85+
* @param textColor Color string
8686
*/
8787
public void setTextColor(String textColor) {
8888
this.textColor = textColor;
@@ -96,7 +96,7 @@ public String getAlign() {
9696

9797
/**
9898
* Set the caption text alignment
99-
* @param align
99+
* @param align Alignment string
100100
*/
101101
public void setAlign(String align) {
102102
this.align = align;
@@ -109,7 +109,7 @@ public String getUrl() {
109109

110110
/**
111111
* Set the image url of the backgroud slide
112-
* @param url
112+
* @param url Url string
113113
*/
114114
public void setUrl(String url) {
115115
this.url = url;
@@ -122,7 +122,7 @@ public ImageResource getResource() {
122122

123123
/**
124124
* You can define also the image resource if you are not using image URL
125-
* @param resouce
125+
* @param resource ImageResource object
126126
*/
127127
public void setResouce(ImageResource resource) {
128128
this.resource = resource;

src/main/java/gwt/material/design/client/ui/MaterialSplashScreen.java

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@ public MaterialSplashScreen(int splashTime,final Composite main, ImageResource l
7474

7575
/**
7676
* Show the splash screen
77-
* @return
7877
*/
7978
public void show(){
8079
RootPanel.get().clear();
@@ -96,7 +95,7 @@ public ImageResource getLogo() {
9695

9796
/**
9897
* The logo of the Splash screen
99-
* @param logo
98+
* @param logo ImageResource object
10099
*/
101100
public void setLogo(ImageResource logo) {
102101
this.logo = logo;
@@ -109,7 +108,7 @@ public String getAppName() {
109108

110109
/**
111110
* The app name displayed on Splash Screen
112-
* @param appName
111+
* @param appName Application name string
113112
*/
114113
public void setAppName(String appName) {
115114
this.appName = appName;
@@ -123,7 +122,6 @@ public String getAppDescription() {
123122

124123
/**
125124
* Optional , you can add your app description on Splash Screen
126-
* @return
127125
*/
128126
public void setAppDescription(String appDescription) {
129127
this.appDescription = appDescription;
@@ -136,7 +134,7 @@ public String getColor() {
136134

137135
/**
138136
* Background Color of your splash screen
139-
* @param color
137+
* @param color Color string
140138
*/
141139
public void setColor(String color) {
142140
this.color = color;
@@ -181,7 +179,7 @@ public int getSplashTime() {
181179

182180
/**
183181
* How long it will take to show your splash screen, by default 5 seconds or 5000 ms
184-
* @param splashTime
182+
* @param splashTime Splash time in milliseconds
185183
*/
186184
public void setSplashTime(int splashTime) {
187185
this.splashTime = splashTime;

src/main/java/gwt/material/design/client/ui/MaterialTabs.java

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,15 +88,15 @@ protected void onAttach() {
8888

8989
/**
9090
* Line Indicator on Tab Navigation
91-
* @param color
91+
* @param color Color string
9292
*/
9393
public native void changeIndicator(String color)/*-{
9494
$wnd.jQuery( ".indicator" ).css( "background-color", color );
9595
}-*/;
9696

9797
/**
9898
* Adding each tab nav , must add also the Content if you add a tab nav item
99-
* @param item
99+
* @param item Widget item
100100
*/
101101
@UiChild(tagname = "tab")
102102
public void addTab(final Widget item) {
@@ -108,7 +108,7 @@ public void addTab(final Widget item) {
108108

109109
/**
110110
* Adding each tab content on the navigation
111-
* @param item
111+
* @param item Widget content
112112
*/
113113
@UiChild(tagname = "content")
114114
public void addContent(final Widget item) {
@@ -128,7 +128,8 @@ public static native void initTabs(String ulId)/*-{
128128

129129
/**
130130
* Selecting the tab with id on the content
131-
* @param id
131+
* @param id Id of the tab
132+
* @param ulId Id of the list
132133
*/
133134
private native void selectTab(String id, String ulId)/*-{
134135
$wnd.jQuery(document).ready(function(){
@@ -166,15 +167,15 @@ public void setTextColor(String textColor) {
166167

167168
/**
168169
* Get the indicator underlined color
169-
* @return
170+
* @return Color string
170171
*/
171172
public String getIndicatorColor() {
172173
return indicatorColor;
173174
}
174175

175176
/**
176177
* Set the indicator underlined color
177-
* @param indicatorColor
178+
* @param indicatorColor Color string
178179
*/
179180
public void setIndicatorColor(String indicatorColor) {
180181
this.indicatorColor = indicatorColor;

0 commit comments

Comments
 (0)