Skip to content

Commit 476099f

Browse files
committed
📚 Improve JavaDocs
1 parent 1e6bd1c commit 476099f

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

src/main/java/org/spdx/Configuration.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,13 @@
2525
import org.slf4j.LoggerFactory;
2626

2727
/**
28-
* A configuration class for the Spdx-Java-Library. When a caller attempts to retrieve a configuration property, it
28+
* The configuration class for the Spdx-Java-Library. When a caller attempts to retrieve a configuration property, it
2929
* will first be checked in the Java system properties (i.e. set via `-D` command line options to the JVM, or by
3030
* programmatic calls to `System.setProperty()` in code), and will then fallback on a properties file in the classpath.
3131
* That file must be called `/resources/spdx-java-library.properties`.
32+
*
33+
* Please see the documentation for specifics on what configuration options Spdx-Java-Library supports, and how they
34+
* impact the library's behavior.
3235
*/
3336
public final class Configuration {
3437
private static final Logger logger = LoggerFactory.getLogger(Configuration.class.getName());

0 commit comments

Comments
 (0)