copy javadoc for Activity @Extra and @FragmentArg to thier Builder

[dodgex]

see #1525

[WonderCsabo]

Can you explain this line?

[dodgex]

i assume you ask for the .replaceAll("\r", ""). I removed the \n because it breaks the output.

e.g.

/**
 * Hello
World
 *
 */

instead of

/**
 * Hello
 * World
 *
 */

[WonderCsabo]

You mean you removed the \r, right? But why is this needed? CodeModel assumes only \n line ending and breaks with \r\n?

[dodgex]

Yes i mean that i removed the \r, sorry.

the .getDocComment(element) call returns comment with \r\n but when i apped that to the javadoc i get the line-break without an * in the line (like the first snippet). removing the \r resulted in having a correctly formatted javadoc output.

[WonderCsabo]

I see. Can you move this duplicated code then to APTCodeModelHelper?

[dodgex]

updated

[WonderCsabo]

I would extract this whole block into one method: if (docComment != null) { method.javadoc().append(codeModelHelper. trimDocComment(docComment)); }

[WonderCsabo]

I would extract this whole block into one method:

if (docComment != null) {
  method.javadoc().append(docComment.replaceAll("\r", "").trim());
}

[dodgex]

done

[WonderCsabo]

Thanks! Seems to be okay. After the plugin system is merged, i will have to ask you to rebase this unfortunately.

[dodgex]

I'm just waiting for the moment i can rebase ;-)

[WonderCsabo]

Please rebase this onto develop.

[dodgex]

rebased

[WonderCsabo]

It seems you have compilation errors.

[dodgex]

yeah... currently fighting with my eclipse to get AA working.

[WonderCsabo]

Sorry... We changed to IntelliJ. I did not update the instructions, yet.

[dodgex]

the androidannotations-test project is missing project.properties :/

[dodgex]

should be fixed

[dodgex]

TODO: copy ServiceAction javadoc

[WonderCsabo]

@dodgex will you add @ServiceAction javadoc gen in this PR?

[dodgex]

yeah. it is planned. but i had no time yet. maybe this evening.

[WonderCsabo]

OK, i will wait with merging, then. Thanks.

[dodgex]

PR updated with javadoc for @ServiceAction. here it is a plain copy of the original doc.

[WonderCsabo]

Thanks for handling @ServiceAction as well. And it seems it also handles javadoc for parameters correctly:

/**
 * this is a javadoc comment
 *
 * @param param This is something
 */
@ServiceAction
void action(int param) {
}

/**
 * this is a javadoc comment
 * 
 *  @param param This is something
 * 
 */
public ServiceWithServiceAction_.IntentBuilder_ action(int param) {
    action(ACTION);
    super.extra(PARAM_EXTRA, param);
    return this;
}

Can i ask you to add the param to the test? Also please add a @return tag to the ServiceAction javadoc as you did for the other two annotations (and also test that)..

Thanks for your work!

[WonderCsabo]

Well, the only little problem with @param that it is has extra space before it. But i think that is okay, since JavaDoc parsers should be able to handle that (IntelliJ's can).

[dodgex]

no idea where the space comes from. but i'm pretty sure that JavaDoc parsers do not care for spaces at all (if not in a <pre> block)

[dodgex]

PR updated

[WonderCsabo]

I know where it comes from. The javadoc which is added here, is interpreted as the main JavaDoc. When codemodel renders it, it adds a space after the starts. But the @param already has a space, that is why it is duplicated. But this is not a problem.

[WonderCsabo]

After the final review of this PR, i realized there is another last annotations, which can use JavaDoc copy: @SharedPref and @DefaultXXX. These are not so important, but if you want to contribute that too, go ahead.

[WonderCsabo]

Follow up issue for shared prefs: #1551.