Skip to content

Commit

Permalink
Merge pull request #141 from ahus1/fixup-asciidoclet
Browse files Browse the repository at this point in the history
fixup Asciidoclet using include paths
  • Loading branch information
chrisvest committed May 27, 2024
2 parents aeaca06 + 7101295 commit e926341
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions src/main/java/stormpot/ManagedPool.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@
* Once you have created your pool, it is easy to expose it through the platform
* MBeanServer, or any MBeanServer you like:
*
* [source,java]
* [source,java,indent=0]
* ----
* include::../src/test/java/examples/Examples.java[tag=managedPoolExample]
* include::src/test/java/examples/Examples.java[tag=managedPoolExample]
* ----
*
* Using the platform MBeanServer will make the pool visible to tools like
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/stormpot/MetricsRecorder.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
*
* [source,java]
* ----
* include::../src/test/java/examples/DropwizardMetricsRecorder.java[lines=16..-1]
* include::src/test/java/examples/DropwizardMetricsRecorder.java[lines=16..-1]
* ----
*
* @since 2.3
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/stormpot/Pool.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@
* {@link Poolable#release() releasing} that object again. By far the most
* common idiom to achieve this is with a `try-finally` clause:
*
* [source,java]
* [source,java,indent=0]
* ----
* include::../src/test/java/examples/Examples.java[tag=poolClaimExample]
* include::src/test/java/examples/Examples.java[tag=poolClaimExample]
* ----
*
* The pools are resizable, and can have their capacity changed at any time
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/stormpot/PoolTap.java
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ public abstract class PoolTap<T extends Poolable> {
* Here's an example code snippet, where an object is claimed, printed to
* `System.out`, and then released back to the pool:
*
* [source,java]
* [source,java,indent=0]
* ----
* include::../src/test/java/examples/Examples.java[tag=poolClaimPrintExample]
* include::src/test/java/examples/Examples.java[tag=poolClaimPrintExample]
* ----
*
* Memory effects:
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/stormpot/Poolable.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@
*
* A simple correct implementation of the Poolable interface looks like this:
*
* [source,java]
* [source,java,indent=0]
* ----
* include::../src/test/java/examples/Examples.java[tag=poolableGenericExample]
* include::src/test/java/examples/Examples.java[tag=poolableGenericExample]
* ----
*
* This can be shortened further by extending the {@link BasePoolable} class:
*
* [source,java]
* [source,java,indent=0]
* ----
* include::../src/test/java/examples/Examples.java[tag=poolableBaseExample]
* include::src/test/java/examples/Examples.java[tag=poolableBaseExample]
* ----
*
* It is also possible to directly use the {@link Pooled} implementation, which
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/stormpot/Reallocator.java
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public interface Reallocator<T extends Poolable> extends Allocator<T> {
*
* This method is effectively equivalent to the following:
*
* [source,java]
* [source,java,indent=0]
* --
* include::src/test/java/examples/Examples.java[tag=reallocatorExample]
* --
Expand Down

0 comments on commit e926341

Please sign in to comment.