johncarl81 / parceler

:package: Android Parcelables made easy through code generation.
http://parceler.org
Apache License 2.0
3.56k stars 273 forks source link

Add documentation for proguard rules #77

Closed emartynov closed 9 years ago

emartynov commented 9 years ago

Library could be shipped with own rules since gradle supports merging rules from proguard.cfg from libraries. But this will require to pack it as aar library.

johncarl81 commented 9 years ago

Could we accomplish this with the existing Maven build? I assume we would just need to add this to the parceler-api module.

emartynov commented 9 years ago

Building aar is supported by android maven plugin. But adding the proguard rules is probably by gradle only. Probably should wait for next android maven plugin release: https://github.com/simpligility/android-maven-plugin/issues/611

johncarl81 commented 9 years ago

Would you like to put together a PR in anticipation of the next Maven plugin release @emartynov ?

emartynov commented 9 years ago

Sure thing!

As soon as PR merged we could start using SNAPSHOT and try it out. Even better we just take fork from requester and use local SNAPSHOT.

But documentation is still must be provided for people who are using older android gradle plugins

johncarl81 commented 9 years ago

The documentation is fully editable via git (both the README in this repo and we website: https://github.com/johncarl81/parceler-site. PRs are appreciated there as well.

emartynov commented 9 years ago

Do I understand correctly that for website I should generate adoc from asciidoc?

johncarl81 commented 9 years ago

Jekyll and Travis will generate it automatically, but if you want to run it locally just run jekyll serve (See https://github.com/asciidoctor/jekyll-asciidoc-quickstart)

emartynov commented 9 years ago

So I need to do same edits in both places. Clear! Probably could be automated

johncarl81 commented 9 years ago

Agreed, but they are slightly different.

funkthemonk commented 9 years ago

I also had to add -dontwarn org.parceler. -dontwarn javax_.lang.model.util.

johncarl81 commented 9 years ago

@funkthemonk, what (generated I suppose) classes under javax.lang.model.util are producing warnings?