diff --git a/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/exception/package-info.java b/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/exception/package-info.java new file mode 100644 index 000000000..2780c7b68 --- /dev/null +++ b/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/exception/package-info.java @@ -0,0 +1,11 @@ +/** + * + *
+ *A collection of exception classes used within the application.
+ * + * + */ +package org.owasp.dependencycheck.data.update.exception; diff --git a/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/package-info.java b/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/package-info.java index a6251592d..2f7be0a40 100644 --- a/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/package-info.java +++ b/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/package-info.java @@ -1,18 +1,15 @@ /** * * - *Contains classes used to parse the NVD CVE XML file.
- *The basic use is that the Importer is called to import - * an NVD CVE file. The Importer instantiates an Indexer object - * (which extends Index). The Indexer creates a partial-unmarshalling - * SAX parser (implemented in the NvdCveXmlFilter) that extracts - * VulnerabilityTypes (aka Entry) from the NVD CVE data file and - * stores these into a Lucene Index.
+ *Contains classes used to update the data stores.
+ *The UpdateService will load, any correctly defined CachedWebDataSource(s) + * and call update() on them. The Cached Data Source must determine if it needs + * to be updated and if so perform the update. The sub packages contain classes + * used to perform the actual updates.
* * -*/ - + */ package org.owasp.dependencycheck.data.update; diff --git a/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/task/package-info.java b/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/task/package-info.java new file mode 100644 index 000000000..ea71957fd --- /dev/null +++ b/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/task/package-info.java @@ -0,0 +1,12 @@ +/** + * + * + *A collection of callable/runnable tasks used to speed up the update + * process.
+ * + * + */ +package org.owasp.dependencycheck.data.update.task; diff --git a/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/xml/package-info.java b/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/xml/package-info.java new file mode 100644 index 000000000..a6251592d --- /dev/null +++ b/dependency-check-core/src/main/java/org/owasp/dependencycheck/data/update/xml/package-info.java @@ -0,0 +1,18 @@ +/** + * + * + *Contains classes used to parse the NVD CVE XML file.
+ *The basic use is that the Importer is called to import + * an NVD CVE file. The Importer instantiates an Indexer object + * (which extends Index). The Indexer creates a partial-unmarshalling + * SAX parser (implemented in the NvdCveXmlFilter) that extracts + * VulnerabilityTypes (aka Entry) from the NVD CVE data file and + * stores these into a Lucene Index.
+ * + * +*/ + +package org.owasp.dependencycheck.data.update; diff --git a/dependency-check-core/src/main/java/org/owasp/dependencycheck/exception/package-info.java b/dependency-check-core/src/main/java/org/owasp/dependencycheck/exception/package-info.java new file mode 100644 index 000000000..25fcd7982 --- /dev/null +++ b/dependency-check-core/src/main/java/org/owasp/dependencycheck/exception/package-info.java @@ -0,0 +1,11 @@ +/** + * + * + *A collection of exception classes used within the application.
+ * + * + */ +package org.owasp.dependencycheck.exception;