From 0914c82f69a70ba033b1059f1160f506b8bbc6c2 Mon Sep 17 00:00:00 2001
From: Mike Hearn <mike@plan99.net>
Date: Thu, 2 Oct 2014 13:49:21 +0200
Subject: [PATCH] Add package-info files for the javadocs.

---
 core/src/main/java/org/bitcoinj/core/package-info.java    | 8 ++++++++
 core/src/main/java/org/bitcoinj/crypto/package-info.java  | 8 ++++++++
 core/src/main/java/org/bitcoinj/kits/package-info.java    | 5 +++++
 .../java/org/bitcoinj/net/discovery/package-info.java     | 4 ++++
 core/src/main/java/org/bitcoinj/net/package-info.java     | 6 ++++++
 core/src/main/java/org/bitcoinj/params/package-info.java  | 5 +++++
 .../org/bitcoinj/protocols/channels/package-info.java     | 5 +++++
 .../main/java/org/bitcoinj/protocols/package-info.java    | 5 +++++
 .../org/bitcoinj/protocols/payments/package-info.java     | 5 +++++
 core/src/main/java/org/bitcoinj/script/package-info.java  | 4 ++++
 core/src/main/java/org/bitcoinj/signers/package-info.java | 6 ++++++
 core/src/main/java/org/bitcoinj/store/package-info.java   | 7 +++++++
 core/src/main/java/org/bitcoinj/testing/package-info.java | 6 ++++++
 core/src/main/java/org/bitcoinj/uri/package-info.java     | 4 ++++
 core/src/main/java/org/bitcoinj/utils/package-info.java   | 5 +++++
 core/src/main/java/org/bitcoinj/wallet/package-info.java  | 6 ++++++
 16 files changed, 89 insertions(+)
 create mode 100644 core/src/main/java/org/bitcoinj/core/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/crypto/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/kits/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/net/discovery/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/net/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/params/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/protocols/channels/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/protocols/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/protocols/payments/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/script/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/signers/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/store/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/testing/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/uri/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/utils/package-info.java
 create mode 100644 core/src/main/java/org/bitcoinj/wallet/package-info.java

diff --git a/core/src/main/java/org/bitcoinj/core/package-info.java b/core/src/main/java/org/bitcoinj/core/package-info.java
new file mode 100644
index 00000000..2cc8abf8
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/core/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * The core package contains classes for network messages like {@link org.bitcoinj.core.Block} and
+ * {@link org.bitcoinj.core.Transaction}, peer connectivity via {@link org.bitcoinj.core.PeerGroup},
+ * block chain management and the {@link org.bitcoinj.core.Wallet} class.
+ * If what you're doing can be described as basic bitcoin tasks, the code is probably found here.
+ * To learn more please consult the documentation on the website.
+ */
+package org.bitcoinj.core;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/crypto/package-info.java b/core/src/main/java/org/bitcoinj/crypto/package-info.java
new file mode 100644
index 00000000..9c5bc84e
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/crypto/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * The crypto package contains classes that work with key derivation algorithms like scrypt (passwords to AES keys),
+ * BIP 32 hierarchies (chains of keys from a root seed), X.509 utilities for the payment protocol and other general
+ * cryptography tasks. It also contains a class that can disable the (long since obsolete) DRM Java/US Govt imposes
+ * on strong crypto. This is legal because Oracle got permission to ship strong AES to everyone years ago but hasn't
+ * bothered to actually remove the logic barriers.
+ */
+package org.bitcoinj.crypto;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/kits/package-info.java b/core/src/main/java/org/bitcoinj/kits/package-info.java
new file mode 100644
index 00000000..b29b5f35
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/kits/package-info.java
@@ -0,0 +1,5 @@
+/**
+ * High level wrapper APIs around the bitcoinj building blocks. WalletAppKit is suitable for many different types of
+ * apps that require an SPV wallet.
+ */
+package org.bitcoinj.kits;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/net/discovery/package-info.java b/core/src/main/java/org/bitcoinj/net/discovery/package-info.java
new file mode 100644
index 00000000..2c8f3176
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/net/discovery/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Classes that know how to discover peers in the P2P network using DNS, IRC or DNS via Tor (orchid).
+ */
+package org.bitcoinj.net.discovery;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/net/package-info.java b/core/src/main/java/org/bitcoinj/net/package-info.java
new file mode 100644
index 00000000..8e4a9f43
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/net/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes handling low level network management using either NIO (async io) or older style blocking sockets (useful for
+ * using SOCKS proxies, Tor, SSL etc). The code in this package implements a simple network abstraction a little like
+ * what the Netty library provides, but with only what bitcoinj needs.
+ */
+package org.bitcoinj.net;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/params/package-info.java b/core/src/main/java/org/bitcoinj/params/package-info.java
new file mode 100644
index 00000000..e750d96b
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/params/package-info.java
@@ -0,0 +1,5 @@
+/**
+ * Network parameters encapsulate some of the differences between different Bitcoin networks such as the main/production
+ * network, the testnet, regtest mode, unit testing params and so on.
+ */
+package org.bitcoinj.params;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/protocols/channels/package-info.java b/core/src/main/java/org/bitcoinj/protocols/channels/package-info.java
new file mode 100644
index 00000000..df339ad0
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/protocols/channels/package-info.java
@@ -0,0 +1,5 @@
+/**
+ * Micropayment channels allow for rapid tiny payments to be made to a third party once a channel has been set up, using
+ * some of the advanced features of the Bitcoin protocol.
+ */
+package org.bitcoinj.protocols.channels;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/protocols/package-info.java b/core/src/main/java/org/bitcoinj/protocols/package-info.java
new file mode 100644
index 00000000..19577a05
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/protocols/package-info.java
@@ -0,0 +1,5 @@
+/**
+ * High level protocols that build on top of Bitcoin go here: we have the payment protocol for sending transactions
+ * from sender to receiver with metadata, and a micropayment channels implementation.
+ */
+package org.bitcoinj.protocols;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/protocols/payments/package-info.java b/core/src/main/java/org/bitcoinj/protocols/payments/package-info.java
new file mode 100644
index 00000000..2c3f9ba0
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/protocols/payments/package-info.java
@@ -0,0 +1,5 @@
+/**
+ * The BIP70 payment protocol wraps Bitcoin transactions and adds various useful features like memos, refund addresses
+ * and authentication.
+ */
+package org.bitcoinj.protocols.payments;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/script/package-info.java b/core/src/main/java/org/bitcoinj/script/package-info.java
new file mode 100644
index 00000000..7dc8381a
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/script/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Classes for working with and executing Bitcoin script programs, as embedded in inputs and outputs.
+ */
+package org.bitcoinj.script;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/signers/package-info.java b/core/src/main/java/org/bitcoinj/signers/package-info.java
new file mode 100644
index 00000000..2d3d5601
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/signers/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Transaction signers know how to calculate signatures over transactions in different contexts, for example, using
+ * local private keys or fetching them from remote servers. The {@link org.bitcoinj.core.Wallet} class uses these
+ * when sending money.
+ */
+package org.bitcoinj.signers;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/store/package-info.java b/core/src/main/java/org/bitcoinj/store/package-info.java
new file mode 100644
index 00000000..b8783471
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/store/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * Block stores persist blockchain data downloaded from remote peers. There is an SPV block store which preserves a ring
+ * buffer of headers on disk and is suitable for lightweight user wallets, a store that's backed by Postgres and which
+ * can calculate a full indexed UTXO set (i.e. it can query address balances), a store that's backed by the embedded H2
+ * database, and a memory only store useful for unit tests.
+ */
+package org.bitcoinj.store;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/testing/package-info.java b/core/src/main/java/org/bitcoinj/testing/package-info.java
new file mode 100644
index 00000000..fed20979
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/testing/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Various utilities for writing unit tests: also useful for testing your own code and apps that build on top of
+ * bitcoinj. Some of these are junit4 classes you can subclass, and others are static utility methods for building
+ * fake transactions and so on.
+ */
+package org.bitcoinj.testing;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/uri/package-info.java b/core/src/main/java/org/bitcoinj/uri/package-info.java
new file mode 100644
index 00000000..a9e8faa7
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/uri/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Parsing and handling of bitcoin: textual URIs as found in qr codes and web links.
+ */
+package org.bitcoinj.uri;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/utils/package-info.java b/core/src/main/java/org/bitcoinj/utils/package-info.java
new file mode 100644
index 00000000..756151a4
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/utils/package-info.java
@@ -0,0 +1,5 @@
+/**
+ * Formatting monetary amounts, representing exchange rates, a program for loading Bitcoin Core saved block files,
+ * a class to control how bitcoinj uses threads and misc other utility classes that don't fit anywhere else.
+ */
+package org.bitcoinj.utils;
\ No newline at end of file
diff --git a/core/src/main/java/org/bitcoinj/wallet/package-info.java b/core/src/main/java/org/bitcoinj/wallet/package-info.java
new file mode 100644
index 00000000..fe802665
--- /dev/null
+++ b/core/src/main/java/org/bitcoinj/wallet/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes that support the {@link org.bitcoinj.core.Wallet}, which knows how to find and save transactions relevant to
+ * a set of keys or scripts, calculate balances, and spend money: the wallet has many features and can be extended
+ * in various ways, please refer to the website for documentation on how to use it.
+ */
+package org.bitcoinj.wallet;
\ No newline at end of file