Skip to content

Commit cfb4753

Browse files
anirudh24sevenanirudh24seven
committed
Resolve javadoc issues
1 parent d17a497 commit cfb4753

File tree

3 files changed

+48
-53
lines changed

3 files changed

+48
-53
lines changed

‎helpstack/src/com/tenmiles/helpstack/HSHelpStack.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public class HSHelpStack {
4444

4545
/**
4646
*
47-
* @param context
47+
* @param context Context
4848
* @return singleton instance of this class.
4949
*/
5050
public static HSHelpStack getInstance(Context context) {
@@ -66,7 +66,7 @@ public static HSHelpStack getInstance(Context context) {
6666
*
6767
* Sets which gear to use in HelpStack. It has to be set before calling any show* functions.
6868
*
69-
* @param gear
69+
* @param gear Gear
7070
*/
7171
public void setGear(HSGear gear) {
7272
this.gear = gear;
@@ -84,7 +84,7 @@ public HSGear getGear() {
8484
*
8585
* Starts a Help activity. It shows all FAQ and also let user report new issue if not found in FAQ.
8686
*
87-
* @param activity
87+
* @param activity Activity
8888
*/
8989
public void showHelp(Activity activity) {
9090
activity.startActivity(new Intent("com.tenmiles.helpstack.ShowHelp"));
@@ -95,7 +95,7 @@ public void showHelp(Activity activity) {
9595
*
9696
* It is light weight call. Call this after calling setGear.
9797
*
98-
* @param articleResId
98+
* @param articleResId Article Resource ID
9999
*/
100100
public void overrideGearArticlesWithLocalArticlePath(int articleResId) {
101101
assert gear != null : "Some gear has to be set before overriding gear with local article path";
@@ -106,7 +106,7 @@ public void overrideGearArticlesWithLocalArticlePath(int articleResId) {
106106
*
107107
* Shows a credit @ bottom of the page.
108108
*
109-
* @param showCredits
109+
* @param showCredits Show Credits or not
110110
*/
111111
public void setShowCredits(boolean showCredits) {
112112
this.showCredits = showCredits;
@@ -115,7 +115,6 @@ public void setShowCredits(boolean showCredits) {
115115
/**
116116
*
117117
* @return if credit can be shown.
118-
* @default Yes
119118
*/
120119
public boolean getShowCredits() {
121120
return this.showCredits;

‎helpstack/src/com/tenmiles/helpstack/fragments/ImageAttachmentDisplayFragment.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333
import android.net.Uri;
3434
import android.os.AsyncTask;
3535
import android.os.Bundle;
36-
import android.support.v4.view.MenuItemCompat;
3736
import android.util.Log;
3837
import android.view.LayoutInflater;
3938
import android.view.Menu;

‎helpstack/src/com/tenmiles/helpstack/logic/HSGear.java

Lines changed: 43 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ public HSGear() {
4242

4343
/**
4444
*
45-
* @param cancelTag
46-
* @param section
47-
* @param queue
48-
* @param success
49-
* @param errorListener
45+
* @param cancelTag Cancel Tag
46+
* @param section Section
47+
* @param queue Queue
48+
* @param success Success listener
49+
* @param errorListener Error listener
5050
*/
5151
public void fetchKBArticle(String cancelTag, HSKBItem section, RequestQueue queue, OnFetchedArraySuccessListener success, ErrorListener errorListener )
5252
{
@@ -55,13 +55,13 @@ public void fetchKBArticle(String cancelTag, HSKBItem section, RequestQueue queu
5555

5656
/**
5757
*
58-
* @param cancelTag
59-
* @param firstName
60-
* @param lastname
61-
* @param emailAddress
62-
* @param queue
63-
* @param success
64-
* @param errorListener
58+
* @param cancelTag Cancel Tag
59+
* @param firstName First Name
60+
* @param lastname Last Name
61+
* @param emailAddress Email Address
62+
* @param queue Queue
63+
* @param success Success Listener
64+
* @param errorListener Error Listener
6565
*/
6666
public void registerNewUser(String cancelTag, String firstName, String lastname, String emailAddress, RequestQueue queue, OnFetchedSuccessListener success, ErrorListener errorListener)
6767
{
@@ -72,24 +72,24 @@ public void registerNewUser(String cancelTag, String firstName, String lastname,
7272
*
7373
* HSUploadAttachment.getAttachment() can contain mime/Type and filename
7474
*
75-
* @param user
76-
* @param subject
77-
* @param body
78-
* @param successListener
79-
* @param errorListener
75+
* @param user User
76+
* @param subject Subject
77+
* @param body Body
78+
* @param successListener Success Listener
79+
* @param errorListener Error Listener
8080
*/
8181
public void createNewTicket(String cancelTag, HSUser user, String subject, String body, HSUploadAttachment[] attachments, RequestQueue queue, OnNewTicketFetchedSuccessListener successListener, ErrorListener errorListener ) {
8282
errorListener.onErrorResponse(new VolleyError("Not implemented method"));
8383
}
8484

8585
/**
8686
*
87-
* @param cancelTag
88-
* @param ticket
89-
* @param user
90-
* @param queue
91-
* @param success
92-
* @param errorListener
87+
* @param cancelTag Cancel Tag
88+
* @param ticket Ticket
89+
* @param user User
90+
* @param queue Queue
91+
* @param success Success Listener
92+
* @param errorListener Error Listener
9393
*/
9494
public void fetchAllUpdateOnTicket(String cancelTag, HSTicket ticket, HSUser user, RequestQueue queue, OnFetchedArraySuccessListener success, ErrorListener errorListener)
9595
{
@@ -98,12 +98,12 @@ public void fetchAllUpdateOnTicket(String cancelTag, HSTicket ticket, HSUser use
9898

9999
/***
100100
*
101-
* @param message
102-
* @param ticket
103-
* @param user
104-
* @param queue
105-
* @param success
106-
* @param errorListener
101+
* @param message Message
102+
* @param ticket Ticket
103+
* @param user User
104+
* @param queue Queue
105+
* @param success Success Listener
106+
* @param errorListener Error Listener
107107
*/
108108
public void addReplyOnATicket(String cancelTag, String message, HSUploadAttachment[] attachments, HSTicket ticket, HSUser user, RequestQueue queue, OnFetchedSuccessListener success, ErrorListener errorListener) {
109109
errorListener.onErrorResponse(new VolleyError("Not implemented method"));
@@ -113,9 +113,9 @@ public void addReplyOnATicket(String cancelTag, String message, HSUploadAttachme
113113
* Set this parameter, if gear is not implementing handling of Issues. Doing this, default email client will be open with given support Email Address.
114114
* Then there is no need to implement issues fetching related methods.
115115
*
116-
* @default it is considered that gear is gonna implement ticket fetching.
116+
* Default: it is considered that gear is gonna implement ticket fetching.
117117
*
118-
* @param companySupportEmailAddress
118+
* @param companySupportEmailAddress Company Support Email Address
119119
*/
120120
public void setNotImplementingTicketsFetching(String companySupportEmailAddress) {
121121
implementsTicketFetching = false;
@@ -132,9 +132,8 @@ public String getCompanySupportEmailAddress() {
132132
/**
133133
* Returns if gear have implemented Ticket Fetching. Modify this parameter using {@link #setNotImplementingTicketsFetching(java.lang.String) setNotImplementingTicketsFetching}
134134
*
135-
* @default true
135+
* Default: true
136136
*
137-
* @return
138137
*/
139138
public boolean haveImplementedTicketFetching() {
140139
return implementsTicketFetching;
@@ -143,9 +142,9 @@ public boolean haveImplementedTicketFetching() {
143142
* Set this parameter, if gear is not implementing handling of FAQ. Doing this, FAQ will be fetched from article path.
144143
* Then there is no need to implement issues fetching related methods.
145144
*
146-
* @default it is considered that gear is gonna implement email fetching.
145+
* Default: it is considered that gear is gonna implement email fetching.
147146
*
148-
* @param articleResid
147+
* @param articleResid Article Resource ID
149148
*/
150149
public void setNotImplementingKBFetching (int articleResid) {
151150
implementsKBFetching = false;
@@ -163,9 +162,8 @@ public int getLocalArticleResourceId() {
163162
/**
164163
* Returns if gear have implemented KB Fetching. Modify this parameter using {@link #setNotImplementingKBFetching(int) setNotImplementingKBFetching}
165164
*
166-
* @default true
165+
* Default: true
167166
*
168-
* @return
169167
*/
170168
public boolean haveImplementedKBFetching() {
171169
return implementsKBFetching;
@@ -175,9 +173,9 @@ public boolean haveImplementedKBFetching() {
175173
*
176174
* If this parameter is set, message written by user in chat screen and new issue screen will be returned in HTML format.
177175
*
178-
* @default false
176+
* Default: false
179177
*
180-
* @param htmlEnabled
178+
* @param htmlEnabled HTML Enabled
181179
*/
182180
public void uploadMessageAsHtmlString(boolean htmlEnabled) {
183181
this.supportHtmlMessage = htmlEnabled;
@@ -186,9 +184,8 @@ public void uploadMessageAsHtmlString(boolean htmlEnabled) {
186184
/**
187185
* returns if gear can upload message as html string.
188186
*
189-
* @default false
187+
* Default: false
190188
*
191-
* @return
192189
*/
193190
public boolean canUplaodMessageAsHtmlString() {
194191
return supportHtmlMessage;
@@ -199,9 +196,9 @@ public boolean canUplaodMessageAsHtmlString() {
199196
*
200197
* Sets maximum number of attachment gears can handle.
201198
*
202-
* @default 1
199+
* Default: 1
203200
*
204-
* @param numberOfAttachmentGearCanHandle
201+
* @param numberOfAttachmentGearCanHandle Number of Attachments that the Gear can handle
205202
*/
206203
public void setNumberOfAttachmentGearCanHandle (int numberOfAttachmentGearCanHandle) {
207204
this.numberOfAttachmentGearCanHandle = numberOfAttachmentGearCanHandle;
@@ -210,7 +207,7 @@ public void setNumberOfAttachmentGearCanHandle (int numberOfAttachmentGearCanHan
210207
/**
211208
*
212209
* @return maximum number of attachment gear can handle.
213-
* @default is 1
210+
* Default: is 1
214211
*/
215212
public int getNumberOfAttachmentGearCanHandle() {
216213
return numberOfAttachmentGearCanHandle;
@@ -220,9 +217,9 @@ public int getNumberOfAttachmentGearCanHandle() {
220217
/**
221218
* if true, gear don't have to return back HSTicketUpdate object, after a reply is been added.
222219
*
223-
* @default: false, means it is necessary for the gear to return HSTicketUpdate object, after a reply is been added.
220+
* Default: false, means it is necessary for the gear to return HSTicketUpdate object, after a reply is been added.
224221
*
225-
* @param canIgnore
222+
* @param canIgnore Can Ignore
226223
*/
227224
public void ignoreTicketUpdateInformationAfterAddingReply(boolean canIgnore) {
228225
this.ignoreTicketUpdateInformationAfterAddingReply = canIgnore;

0 commit comments

Comments
 (0)