IntenseFinance/nosqlbench
3
0
Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc improvements

Browse Source
This commit is contained in:
Jonathan Shook
2023-09-27 23:57:13 -05:00
parent 3ec351ad38
commit 0a3b827372
3 changed files with 27 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
engine-cli/src/main/java/io/nosqlbench/engine/cli/NBCLI.java
View File

@@ -109,7 +109,7 @@ public class NBCLI implements Function<String[], Integer>, NBLabeledElement {
* for scenario encapsulation and concurrent testing. * for scenario encapsulation and concurrent testing.
* *
* @param args * @param args
* Command Line Args * Command Line Args
*/ */
public static void main(final String[] args) { public static void main(final String[] args) {
try { try {

21
nb-api/src/main/java/io/nosqlbench/api/annotations/package-info.java Normal file
View File

@@ -0,0 +1,21 @@
/*
* Copyright (c) 2023 nosqlbench
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* The annotations subsystem allows for identifying lifecycles of key runtime components
* and documenting their parameters and invocations with details for context.
*/
package io.nosqlbench.api.annotations;

10
nb-api/src/main/java/io/nosqlbench/api/system/NBEnvironment.java
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2022 nosqlbench * Copyright (c) 2022-2023 nosqlbench
* *
* 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.
@@ -265,11 +265,11 @@ public class NBEnvironment {
* <li>Any token which exactly matches one of the keys in the provided map is substituted * <li>Any token which exactly matches one of the keys in the provided map is substituted
* directly as is. No token sigil like '$' is used here, so if you want to support that * directly as is. No token sigil like '$' is used here, so if you want to support that
* as is, you need to provide the keys in your substitution map as such.</li> * as is, you need to provide the keys in your substitution map as such.</li>
* <li>Any tokens in the form {@code %f} which is supported by the time fields in * <li>Any token in the form {@code %f} which is supported by the time fields in
* {@link Formatter}</li> are honored and used with the timestamp provided.* * {@link Formatter}</li> are honored and used with the timestamp provided.
* <li>System Properties: Any token in the form {@code $word.word} will be taken as the name * <li>System Properties: Any token in the form {@code $word.word} will be taken as the name
* of a system property to be substited.</li> * of a system property to be substituted.</li>
* <li>Environment Variables: Any token in the form {@code $name}</li> will be takens as * <li>Environment Variables: Any token in the form {@code $name}</li> will be taken as
* an environment variable to be substituted.</li> * an environment variable to be substituted.</li>
* </ul> * </ul>
* *