GT-3362: Another javadoc fix and certifying

This commit is contained in:
Ryan Kurtz 2019-12-17 08:11:13 -05:00
parent 3bdf049d44
commit 222f1e08c0
14 changed files with 14 additions and 26 deletions

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -67,9 +67,9 @@ import ghidra.util.task.TaskMonitor;
* } * }
* }; * };
* *
* {@literal ConcurrentQBuilder<ITEM, RESULT> builder = new ConcurrentQBuilder<ITEM, RESULT>(); * {@literal ConcurrentQBuilder<ITEM, RESULT> builder = new ConcurrentQBuilder<ITEM, RESULT>()};
* builder.setThreadPoolName("Thread Pool Name"); * builder.setThreadPoolName("Thread Pool Name");
* }<span style="color:blue"><b>builder.setListener(itemListener);</b></span> * <span style="color:blue"><b>builder.setListener(itemListener);</b></span>
* concurrentQ = builder.build(callback); * concurrentQ = builder.build(callback);
* ... * ...
* ... * ...
@ -87,11 +87,11 @@ import ghidra.util.task.TaskMonitor;
* public RESULT process(ITEM item, TaskMonitor monitor) { * public RESULT process(ITEM item, TaskMonitor monitor) {
* // do work here... * // do work here...
* } * }
* }; * };}
* *
* ConcurrentQBuilder<ITEM, RESULT> builder = new ConcurrentQBuilder<ITEM, RESULT>(); * {@literal ConcurrentQBuilder<ITEM, RESULT> builder = new ConcurrentQBuilder<ITEM, RESULT>();}
* builder.setThreadPoolName("Thread Pool Name"); * builder.setThreadPoolName("Thread Pool Name");
* }<span style="color:blue"><b>builder.setCollectResults(true);</b></span>{@code * <span style="color:blue"><b>builder.setCollectResults(true);</b></span>
* concurrentQ = builder.getQueue(callback); * concurrentQ = builder.getQueue(callback);
* ... * ...
* ... * ...
@ -99,15 +99,16 @@ import ghidra.util.task.TaskMonitor;
* concurrentQ.add(item); * concurrentQ.add(item);
* concurrentQ.add(item); * concurrentQ.add(item);
* ... * ...
* }<span style="color:blue"><b>{@literal List<QResult<I, R>> results = concurrentQ.waitForResults();}</b></span>{@literal *
* <span style="color:blue"><b>{@literal List<QResult<I, R>> results = concurrentQ.waitForResults();}</b></span>{@literal
* // process the results... * // process the results...
* *
* }</pre> * }</pre>
* <hr> * <hr>
* <p> * <p>
* <u>Put Items, <b>Blocking While Full</b>, and Handle Results in Any Order as They Available:</u> * <u>Put Items, <b>Blocking While Full</b>, and Handle Results in Any Order as They Available:</u>
* <pre>{@literal * <pre>
* QCallback<ITEM, RESULT> callback = new AbstractQCallback<ITEM, RESULT>() { * {@literal QCallback<ITEM, RESULT> callback = new AbstractQCallback<ITEM, RESULT>()} {
* public RESULT process(ITEM item, TaskMonitor monitor) { * public RESULT process(ITEM item, TaskMonitor monitor) {
* // do work here... * // do work here...
* } * }
@ -120,14 +121,14 @@ import ghidra.util.task.TaskMonitor;
* } * }
* }; * };
* *
* ConcurrentQBuilder<ITEM, RESULT> builder = new ConcurrentQBuilder<ITEM, RESULT>(); * {@literal ConcurrentQBuilder<ITEM, RESULT> builder = new ConcurrentQBuilder<ITEM, RESULT>()};
* builder.setThreadPoolName("Thread Pool Name"); * builder.setThreadPoolName("Thread Pool Name");
* }<span style="color:blue"><b>builder.setQueue(new LinkedBlockingQueue(100));</b></span>{@literal * <span style="color:blue"><b>builder.setQueue(new LinkedBlockingQueue(100));</b></span>
* concurrentQ = builder.getQueue(callback); * concurrentQ = builder.getQueue(callback);
* ... * ...
* ... * ...
* Iterator<ITEM> iterator = <get an iterator for 1000s of items somewhere> * {@literal Iterator<ITEM> iterator = <get an iterator for 1000s of items somewhere>}
* }<span style="color:blue"><b>{@code concurrentQ.offer(iterator); // this call will block when the queue fills up (100 items or more)}</b></span> * <span style="color:blue"><b>{@code concurrentQ.offer(iterator); // this call will block when the queue fills up (100 items or more)}</b></span>
* *
* </pre> * </pre>
* <hr> * <hr>

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.

View file

@ -1,6 +1,5 @@
/* ### /* ###
* IP: GHIDRA * IP: GHIDRA
* REVIEWED: YES
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.