Johannes
/
gson-comments
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add READMEs to Maven modules (#2039) 

* Add READMEs to Maven modules

* Address feedback
This commit is contained in:
Marcono1234 2021-12-27 19:17:41 +01:00 committed by GitHub
parent 6ffcdf3029
commit abd2191b0e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 34 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
codegen/README.md Normal file
View File

@ -0,0 +1,5 @@
# gson-codegen
This Maven module contains the source code for automatically generating Gson type adapters.
:warning: This module is currently non-functional and might be removed in the future.

9
examples/android-proguard-example/README.md Normal file
View File

@ -0,0 +1,9 @@
# android-proguard-example
Example Android project showing how to properly configure [ProGuard](https://www.guardsquare.com/proguard).
ProGuard is a tool for 'shrinking' and obfuscating compiled classes. It can rename methods and fields,
or remove them if they appear to be unused. This can cause issues for Gson which uses Java reflection to
access the fields of a class. It is necessary to configure ProGuard to make sure that Gson works correctly.
Also have a look at the [ProGuard manual](https://www.guardsquare.com/manual/configuration/usage#keepoverview)
for more details on how ProGuard can be configured.

6
extras/README.md Normal file
View File

@ -0,0 +1,6 @@
# extras
This Maven module contains the source code for supplementary Gson features which
are not included by default.
The artifacts created by this module are currently not deployed to Maven Central.

7
gson/README
View File

@ -1,7 +0,0 @@
Gson is a Java library that can be used to convert Java Objects into their
JSON representation. It can also be used to convert a JSON string to an
equivalent Java object. Gson can work with arbitrary Java objects including
pre-existing objects that you do not have source-code of.
Complete Gson documentation is available at its project page
https://github.com/google/gson

4
gson/README.md Normal file
View File

@ -0,0 +1,4 @@
# gson
This Maven module contains the Gson source code. The artifacts created by this module
are deployed to Maven Central under the coordinates `com.google.code.gson:gson`.

3
metrics/README.md Normal file
View File

@ -0,0 +1,3 @@
# metrics
This Maven module contains the source code for running internal benchmark tests against Gson.

7
proto/README.md Normal file
View File

@ -0,0 +1,7 @@
# proto
This Maven module contains the source code for a JSON serializer and deserializer for
[Protocol Buffers (protobuf)](https://developers.google.com/protocol-buffers/docs/javatutorial)
messages.
The artifacts created by this module are currently not deployed to Maven Central.