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

if it is possible to read javadoc comments from processed elements/fields it would be nice to copy the javadoc for Activity @Extra and @FragmentArg to the related builder. that allows to have a documented "api".

e.g.

/**
 * [any javadoc]
 */
@Extra("MY_EXTRA_KEY")
protected String myExtra;

->

/**
 * [any javadoc]
 */
public MyActivity_.IntentBuilder_ myExtra(long myExtra) {
    return super.extra(MY_EXTRA, myExtra);
}

dependeing on the possibilities of the code generation extend the javadoc to be valid:

/**
 * [any javadoc]
 *
 * @param myExtra The value to set
 * @return The IntentBuilder to chain calls
 */

thoughts?

maybe even generate the javadoc all the time, but add the text from the field ?

/**
 * [optional: copy field javadoc]
 *
 * Intent/Extra Key: "MY_EXTRA_KEY".
 * 
 * @param myExtra The value to set
 * @return The IntentBuilder to chain calls
 */

Shall we count on you to submit a PR as soon as the project is not frozen due to the plugin refacto any more ?

If this enhancement is welcome i'll try to get a PR up. Any eta on the plugin refactoring?

It's hard to give an ETA for the plugin refacto but I think we are close to the end. All it remains, I think, is to define the API for plugins.

Okay, so I still got some time for this PR. ;)

Before you get too excited: I am not sure the processing API passes the doc at all. Does it?

@WonderCsabo

@WonderCsabo it passes.

String comment = processingEnv.getElementUtils().getDocComment(element);

is there another annotation beside @Extra and @FragementArg that creates a method for a builder?

ServiceAction?

@ServiceAction uses the same code to generate the methods as @Extra so there is the javadoc with the @param and @return already. only having additional custom javadoc text is not possible there as the setter methods are generated by parameters

Great, thanks for looking into this!

Implemented.

Navigation Menu

Repository navigation

copy javadoc for Activity @Extra and @FragmentArg to thier builder #1525

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

copy javadoc for Activity @Extra and @FragmentArg to thier builder #1525

Description

Activity

dodgex commented on Aug 19, 2015

yDelouis commented on Aug 19, 2015

dodgex commented on Aug 19, 2015

yDelouis commented on Aug 19, 2015

dodgex commented on Aug 19, 2015

WonderCsabo commented on Aug 19, 2015

dodgex commented on Aug 19, 2015

dodgex commented on Aug 19, 2015

WonderCsabo commented on Aug 22, 2015

dodgex commented on Aug 23, 2015

WonderCsabo commented on Sep 1, 2015

WonderCsabo commented on Sep 15, 2015

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions