Skip to content

Commit c293583

Browse files
committed
Fix javadoc after yDelouis’s review
1 parent 4782792 commit c293583

19 files changed

Lines changed: 40 additions & 31 deletions

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/AfterViews.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@
2626
* Methods annotated with @{@link AfterViews} will be called after
2727
* {@link Activity#setContentView(int)} is called by the generated activity.
2828
* <p/>
29-
* This occurs AFTER <b>super.onCreate() is called</b>. Any view depending code
30-
* should be done in an {@link AfterViews} annotated method.
29+
* This occurs AFTER <code>setContentView(View)</code> which is called at the
30+
* end of super.onCreate(). Any view depending code should be done in an
31+
* {@link AfterViews} annotated method.
3132
* <p/>
3233
* The method MUST have zero parameters.
3334
* <p/>

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/Background.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
* </blockquote>
6161
* <p/>
6262
* <b>Note</b>: Cancellation may or may not be successful. If the task wasn't
63-
* executed yet, it will be removed from the pool. But i could fail if task has
63+
* executed yet, it will be removed from the pool. But it could fail if task has
6464
* already completed, has already been cancelled, or could not be cancelled for
6565
* some other reason. See {@link Future#cancel(boolean)} for more information.
6666
*

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/Click.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
* by {@link android.view.View.OnClickListener#onClick(android.view.View)} when
2626
* the view has been clicked by the user.
2727
* <p/>
28-
* The annotation value should be one of R.id.* fields. If not set, the method
29-
* name will be used as the R.id.* field name.
28+
* The annotation value should be one or several of R.id.* fields. If not set,
29+
* the method name will be used as the R.id.* field name.
3030
* <p/>
3131
* The method MAY have one parameter:
3232
* <ul>

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/CustomTitle.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@
2121
import java.lang.annotation.Target;
2222

2323
/**
24-
* Use it on activities to set a custom title layout.
24+
* Use it on {@link EActivity} annotated classes to set a custom title layout.
2525
* <p/>
26-
* The activity must be annotated with {@link EActivity}.
26+
* The annotation value is mandatory and should be one of R.layout.* fields.
2727
* <p/>
2828
* <blockquote>
2929
*
3030
* Example :
3131
*
3232
* <pre>
33-
* &#064;CustomTitle(R.string.activityTitle)
33+
* &#064;CustomTitle(R.layout.activityTitleLayout)
3434
* &#064;EActivity(R.layout.main)
3535
* public class MyActivity extends Activity {
3636
*

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/EActivity.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
* AndroidAnnotations to create Abstract classes that handle common code.
3636
* <p/>
3737
* The annotation value should be one of R.layout.* fields. If not set, no
38-
* content view will be set, and you should call the setContentView() method
39-
* yourself, in <b>onCreate()</b>
38+
* content view will be set, and you should call the
39+
* <code>setContentView()</code> method yourself, in <code>onCreate()</code>
4040
* <p/>
4141
* <blockquote>
4242
*

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/EBean.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@
2323
/**
2424
* Should be used on custom classes to enable usage of AndroidAnnotations.
2525
* <p/>
26+
* This class MUST have either a default constructor (ie without parameters) or
27+
* a constructor with only a parameter of type {@link android.app.Context}.
28+
* <p/>
2629
* Your code related to injected beans should go in an {@link AfterInject}
2730
* annotated method.
2831
* <p/>

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/EFragment.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@
3636
* AndroidAnnotations to create Abstract classes that handle common code.
3737
* <p/>
3838
* The annotation value should be one of R.layout.* fields. If not set, no
39-
* content view will be set, and you should call the setContentView() method
40-
* yourself, in <b>onCreate()</b>
39+
* content view will be set, and you should call the
40+
* <code>inflater.inflate()</code> method yourself, in
41+
* <code>onCreateView()</code>.
4142
* <p/>
4243
* The generated class will also contain a FragmentBuilder to build fragment
4344
* with a fluent API. Arguments can be passed by using {@link FragmentArg}

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/FromHtml.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@
2727
* {@link android.widget.TextView} subclass field annotated with
2828
* {@link ViewById} to inject text as HTML.
2929
* <p/>
30-
* The annotation value should be a R.id.* field that refers to string resource.
31-
* If not set, the method name will be used as the R.id.* field name.
30+
* The annotation value should be a R.string.* field that refers to string
31+
* resource. If not set, the method name will be used as the R.string.* field
32+
* name.
3233
* <p/>
3334
* <blockquote>
3435
*

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/ItemClick.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
* AdapterView<?>, android.view.View, int, long)} when a list item has been
2828
* clicked by the user.
2929
* <p/>
30-
* The annotation value should be one of R.id.* fields. If not set, the method
31-
* name will be used as the R.id.* field name.
30+
* The annotation value should be one or several of R.id.* fields. If not set,
31+
* the method name will be used as the R.id.* field name.
3232
* <p/>
3333
* The method MAY have one parameter :
3434
* <ul>

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/ItemLongClick.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
* widget. AdapterView<?>, android.view.View, int, long)} when a list item has
2828
* been long clicked by the user.
2929
* <p/>
30-
* The annotation value should be one of R.id.* fields. If not set, the method
31-
* name will be used as the R.id.* field name.
30+
* The annotation value should be one or several of R.id.* fields. If not set,
31+
* the method name will be used as the R.id.* field name.
3232
* <p/>
3333
* The method MAY have one parameter :
3434
* <ul>

0 commit comments

Comments
 (0)