From dcb3e1f7f0865a57113c5bac03cf3fb48321a22a Mon Sep 17 00:00:00 2001 From: Grahame Grieve Date: Fri, 6 Mar 2020 12:30:41 +1100 Subject: [PATCH] improve documentation --- .../org/hl7/fhir/validation/ValidationEngine.java | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/org.hl7.fhir.validation/src/main/java/org/hl7/fhir/validation/ValidationEngine.java b/org.hl7.fhir.validation/src/main/java/org/hl7/fhir/validation/ValidationEngine.java index 4fda919e7..4e0f3b622 100644 --- a/org.hl7.fhir.validation/src/main/java/org/hl7/fhir/validation/ValidationEngine.java +++ b/org.hl7.fhir.validation/src/main/java/org/hl7/fhir/validation/ValidationEngine.java @@ -106,19 +106,15 @@ POSSIBILITY OF SUCH DAMAGE. * * 1/ Initialize * ValidationEngine validator = new ValidationEngine(src); - * - this must refer to the igpack.zip for the version of the spec against which you want to validate - * it can be a url or a file reference. It can nominate the igpack.zip directly, - * or it can name the container alone (e.g. just the spec URL). - * The validation engine does not cache igpack.zip. the user must manage that if desired + * - this must be the packageId of the relevant core specification + * for the version you want to validate against (e.g. hl7.fhir.r4.core) * * validator.connectToTSServer(txServer); * - this is optional; in the absence of a terminology service, snomed, loinc etc will not be validated * * validator.loadIg(src); - * - call this any number of times for the Implementation Guide(s) of interest. This is a reference - * to the igpack.zip for the implementation guide - same rules as above - * the version of the IGPack must match that of the spec - * Alternatively it can point to a local folder that contains conformance resources. + * - call this any number of times for the Implementation Guide(s) of interest. + * - See https://confluence.hl7.org/display/FHIR/Using+the+FHIR+Validator for documentation about the src parameter (-ig parameter) * * validator.loadQuestionnaire(src) * - url or filename of a questionnaire to load. Any loaded questionnaires will be used while validating @@ -136,7 +132,8 @@ POSSIBILITY OF SUCH DAMAGE. * if the source is provided as byte[] or stream, you need to provide a format too, though you can * leave that as null, and the validator will guess * - * 3. Or, instead of validating, transform + * 3. Or, instead of validating, transform (see documentation and use in Validator.java) + * * @author Grahame Grieve * */