@@ -44,7 +44,7 @@ public class HSHelpStack {
44
44
45
45
/**
46
46
*
47
- * @param context
47
+ * @param context Context
48
48
* @return singleton instance of this class.
49
49
*/
50
50
public static HSHelpStack getInstance (Context context ) {
@@ -66,7 +66,7 @@ public static HSHelpStack getInstance(Context context) {
66
66
*
67
67
* Sets which gear to use in HelpStack. It has to be set before calling any show* functions.
68
68
*
69
- * @param gear
69
+ * @param gear Gear
70
70
*/
71
71
public void setGear (HSGear gear ) {
72
72
this .gear = gear ;
@@ -84,7 +84,7 @@ public HSGear getGear() {
84
84
*
85
85
* Starts a Help activity. It shows all FAQ and also let user report new issue if not found in FAQ.
86
86
*
87
- * @param activity
87
+ * @param activity Activity
88
88
*/
89
89
public void showHelp (Activity activity ) {
90
90
activity .startActivity (new Intent ("com.tenmiles.helpstack.ShowHelp" ));
@@ -95,7 +95,7 @@ public void showHelp(Activity activity) {
95
95
*
96
96
* It is light weight call. Call this after calling setGear.
97
97
*
98
- * @param articleResId
98
+ * @param articleResId Article Resource ID
99
99
*/
100
100
public void overrideGearArticlesWithLocalArticlePath (int articleResId ) {
101
101
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) {
106
106
*
107
107
* Shows a credit @ bottom of the page.
108
108
*
109
- * @param showCredits
109
+ * @param showCredits Show Credits or not
110
110
*/
111
111
public void setShowCredits (boolean showCredits ) {
112
112
this .showCredits = showCredits ;
@@ -115,7 +115,6 @@ public void setShowCredits(boolean showCredits) {
115
115
/**
116
116
*
117
117
* @return if credit can be shown.
118
- * @default Yes
119
118
*/
120
119
public boolean getShowCredits () {
121
120
return this .showCredits ;
0 commit comments