Skip to content

Commit

Permalink
Fixed checkstyle issues with the tags
Browse files Browse the repository at this point in the history
  • Loading branch information
ghacupha committed Jun 6, 2018
1 parent b493f2f commit 48267f9
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 9 deletions.
35 changes: 35 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,42 @@

# Changelog

Changelog for ghacupha book-keeper.

## Unreleased
### No issue

**Configured mycilia header styles**


[b493f2f551873e4](https://github.com/ghacupha/book-keeper/commit/b493f2f551873e4) Edwin Njeru *2018-06-06 09:36:35*

**Removed mycilia license plugin version and removed license header checking from the checkstyle config**


[d6e1b9d6d7583dc](https://github.com/ghacupha/book-keeper/commit/d6e1b9d6d7583dc) Edwin Njeru *2018-06-06 09:10:22*

**Added jitpack repository**


[f5f5cf7c47afb7f](https://github.com/ghacupha/book-keeper/commit/f5f5cf7c47afb7f) Edwin Njeru *2018-06-06 09:05:35*

**Removed additional unnecessary plugins**


[d10c170440a7ec5](https://github.com/ghacupha/book-keeper/commit/d10c170440a7ec5) Edwin Njeru *2018-06-06 09:02:33*

**Removed unnecessary plugin management**


[5ef71a0aa8ebab0](https://github.com/ghacupha/book-keeper/commit/5ef71a0aa8ebab0) Edwin Njeru *2018-06-06 08:52:24*

**Removed maven site plugin**


[1db7c579635fa03](https://github.com/ghacupha/book-keeper/commit/1db7c579635fa03) Edwin Njeru *2018-06-06 08:43:46*


## 1.2.0
### No issue

Expand Down
4 changes: 2 additions & 2 deletions src/main/java/io/github/ghacupha/keeper/book/api/Account.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

/**
* A collection of {@link Entry} items.
* @implNote The specification of this interface hides the fact that the {@link Account} contains an {@link AccountSide}
* The specification of this interface hides the fact that the {@link Account} contains an {@link AccountSide}
* field. This reduces excessive of the implementation internals, but if the implementation does not contain
* an {@link AccountSide} then the point of this interface is moot. Therefore the only to safely access the
* {@link AccountSide} is through the {@link AccountBalance}.
Expand Down Expand Up @@ -76,7 +76,7 @@ public interface Account {
TimePoint getOpeningDate();

/**
* @implSpec As per implementation notes this is for use only by the {@link AccountAppraisalDelegate}
* As per implementation notes this is for use only by the {@link AccountAppraisalDelegate}
* allowing inexpensive evaluation of the {@link AccountBalance} without causing circular reference. Otherwise anyone else who needs
* to know the {@code AccountSide} of this needs to query the {@link AccountBalance} first, and from it acquire the {@link AccountSide}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public TimePoint getOpeningDate() {
/**
* @return Shows the side of the balance sheet to which this belongs which could be either
* {@link AccountSide#DEBIT} or {@link AccountSide#CREDIT}
* @implSpec As per implementation notes this is for use only by the {@link AccountAppraisalDelegate}
* As per implementation notes this is for use only by the {@link AccountAppraisalDelegate}
* allowing inexpensive evaluation of the {@link AccountBalance} without causing circular reference. Otherwise anyone else who needs
* to know the {@code AccountSide} of this needs to query the {@link AccountBalance} first, and from it acquire the {@link AccountSide}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
* also assigned on initialization allowing the client to describe default {@link AccountSide} of the {@link Account}.
*
* @author edwin.njeru
* @implNote Some non-guaranteed care has been taken to make the Implementation as thread-safe as possible. This may not
* Some non-guaranteed care has been taken to make the Implementation as thread-safe as possible. This may not
* be obviously evident by the usual use of words like "synchronized" et al. In fact synchronization would probably just
* slow us down. Instead what has been done is that the {@link Collection} of {@link Entry} items, which is the whole
* concept of this Account pattern, has been implemented using a {@link List} interface implementation that creates a new
Expand Down Expand Up @@ -188,7 +188,7 @@ public String toString() {
/**
* @return Shows the side of the balance sheet to which this belongs which could be either
* {@link AccountSide#DEBIT} or {@link AccountSide#CREDIT}
* @implSpec As per implementation notes this is for use only by the {@link AccountAppraisalDelegate}
* As per implementation notes this is for use only by the {@link AccountAppraisalDelegate}
* allowing inexpensive evaluation of the {@link AccountBalance} without causing circular reference. Otherwise anyone else who needs
* to know the {@code AccountSide} of this needs to query the {@link AccountBalance} first, and from it acquire the {@link AccountSide}.
* Also note that the object's {@link AccountSide} is never really exposed since this implementation is returning a value based on its
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import io.github.ghacupha.keeper.book.unit.money.Cash;

/**
* The Account could either be in {@link AccountSide#CREDIT} or {@link AccountSide#DEBT}
* The Account could either be in {@link AccountSide#CREDIT} or {@code AccountSide#DEBT}
* This interface maintains the methods common to all these states to allow
* reuse
*
Expand All @@ -30,9 +30,9 @@ public interface AccountState {

/**
* Get AccountBalance given the sum of debits and sum of credits
* @param debits
* @param credits
* @return
* @param debits The amount of money on the debit side
* @param credits The amount of money on the credit side
* @return AccountBalance of the client
*/
AccountBalance getAccountBalance(Cash debits,Cash credits);

Expand Down

0 comments on commit 48267f9

Please sign in to comment.