From 64317506d6994a8e83e935ac6c1cd4ae977c2eac Mon Sep 17 00:00:00 2001 From: Martin Monperrus Date: Fri, 9 Feb 2018 18:09:41 +0100 Subject: [PATCH] doc: add missing javadoc --- .../spoon/compiler/builder/SourceOptions.java | 3 ++ .../spoon/reflect/factory/CoreFactory.java | 7 ++++ .../java/spoon/reflect/factory/Factory.java | 41 +++++++++++++------ .../java/spoon/reflect/visitor/CtVisitor.java | 18 ++++++++ .../reflect/visitor/chain/CtConsumer.java | 1 + .../reflect/visitor/chain/CtFunction.java | 1 + .../support/visitor/SignaturePrinter.java | 1 + .../spoon/testing/utils/ProcessorUtils.java | 1 + 8 files changed, 61 insertions(+), 12 deletions(-) diff --git a/src/main/java/spoon/compiler/builder/SourceOptions.java b/src/main/java/spoon/compiler/builder/SourceOptions.java index 34bf0c5d556..fcf0239bca4 100644 --- a/src/main/java/spoon/compiler/builder/SourceOptions.java +++ b/src/main/java/spoon/compiler/builder/SourceOptions.java @@ -30,6 +30,7 @@ public SourceOptions() { super(SourceOptions.class); } + /** adds the given paths as concatenated string with File.pathSeparator as sources */ public T sources(String sources) { if (sources == null || sources.isEmpty()) { return myself; @@ -37,6 +38,7 @@ public T sources(String sources) { return sources(sources.split(File.pathSeparator)); } + /** adds the given paths as sources */ public T sources(String... sources) { if (sources == null || sources.length == 0) { args.add("."); @@ -46,6 +48,7 @@ public T sources(String... sources) { return myself; } + /** adds the given {@link spoon.compiler.SpoonFile} as sources */ public T sources(List sources) { if (sources == null || sources.size() == 0) { args.add("."); diff --git a/src/main/java/spoon/reflect/factory/CoreFactory.java b/src/main/java/spoon/reflect/factory/CoreFactory.java index 92562f1b2eb..a014c52c2a0 100644 --- a/src/main/java/spoon/reflect/factory/CoreFactory.java +++ b/src/main/java/spoon/reflect/factory/CoreFactory.java @@ -395,6 +395,7 @@ SourcePosition createSourcePosition( CompilationUnit compilationUnit, int startSource, int end, int[] lineSeparatorPositions); + /** Creates a source position that points to the given compilation unit */ SourcePosition createPartialSourcePosition(CompilationUnit compilationUnit); /** @@ -561,15 +562,21 @@ BodyHolderSourcePosition createBodyHolderSourcePosition( */ CtTypeReference createWildcardStaticTypeMemberReference(); + /** Creates a Java 9 module */ CtModule createModule(); + /** Creates a reference to a Java 9 module */ CtModuleReference createModuleReference(); + /** Creates a "requires" directive for a Java 9 module file */ CtModuleRequirement createModuleRequirement(); + /** Creates a "export" directive for a Java 9 module file */ CtPackageExport createPackageExport(); + /** Creates a "provides" directive for a Java 9 module file */ CtProvidedService createProvidedService(); + /** Creates a "uses" directive for a Java 9 module file */ CtUsedService createUsedService(); } diff --git a/src/main/java/spoon/reflect/factory/Factory.java b/src/main/java/spoon/reflect/factory/Factory.java index 91323964f01..ebfa4b6426e 100644 --- a/src/main/java/spoon/reflect/factory/Factory.java +++ b/src/main/java/spoon/reflect/factory/Factory.java @@ -134,38 +134,55 @@ public interface Factory { /** returns the Spoon model that has been built with this factory or one of its subfactories */ CtModel getModel(); - CoreFactory Core(); // used 238 times + /** Access to {@link CoreFactory} subfactory */ + CoreFactory Core(); + /** Access to {@link TypeFactory} subfactory */ TypeFactory Type(); // used 107 times + /** Access to {@link EnumFactory} subfactory */ EnumFactory Enum(); - Environment getEnvironment(); // used 71 times + /** Access to the {@link Environment} */ + Environment getEnvironment(); - PackageFactory Package(); // used 30 times + /** Access to {@link PackageFactory} subfactory */ + PackageFactory Package(); - CodeFactory Code(); // used 28 times + /** Access to {@link CodeFactory} subfactory */ + CodeFactory Code(); - ClassFactory Class(); // used 27 times + /** Access to {@link ClassFactory} subfactory */ + ClassFactory Class(); - FieldFactory Field(); // used 9 times + /** Access to {@link FieldFactory} subfactory */ + FieldFactory Field(); - ExecutableFactory Executable(); // used 8 times + /** Access to {@link ExecutableFactory} subfactory */ + ExecutableFactory Executable(); - CompilationUnitFactory CompilationUnit(); // used 7 times + /** Access to {@link CompilationUnitFactory} subfactory */ + CompilationUnitFactory CompilationUnit(); + /** Access to {@link InterfaceFactory} subfactory */ InterfaceFactory Interface(); - MethodFactory Method(); // used 5 times + /** Access to {@link MethodFactory} subfactory */ + MethodFactory Method(); - AnnotationFactory Annotation(); // used 4 times + /** Access to {@link AnnotationFactory} subfactory */ + AnnotationFactory Annotation(); - EvalFactory Eval(); // used 4 times + /** Access to {@link EvalFactory} subfactory */ + EvalFactory Eval(); - ConstructorFactory Constructor(); // used 3 times + /** Access to {@link ConstructorFactory} subfactory */ + ConstructorFactory Constructor(); + /** Access to {@link QueryFactory} subfactory */ QueryFactory Query(); + /** Access to {@link ModuleFactory} subfactory for Java 9 modules */ ModuleFactory Module(); /** diff --git a/src/main/java/spoon/reflect/visitor/CtVisitor.java b/src/main/java/spoon/reflect/visitor/CtVisitor.java index 38053e547cd..50517c3c15f 100644 --- a/src/main/java/spoon/reflect/visitor/CtVisitor.java +++ b/src/main/java/spoon/reflect/visitor/CtVisitor.java @@ -479,15 +479,33 @@ void visitCtOperatorAssignment( */ void visitCtImport(CtImport ctImport); + /** + * Visits a module declaration + */ void visitCtModule(CtModule module); + /** + * Visits a module reference + */ void visitCtModuleReference(CtModuleReference moduleReference); + /** + * Visits a package export in a module declaration. + */ void visitCtPackageExport(CtPackageExport moduleExport); + /** + * Visits a "require" directive in a module declaration. + */ void visitCtModuleRequirement(CtModuleRequirement moduleRequirement); + /** + * Visits a "provides" directive in a module declaration. + */ void visitCtProvidedService(CtProvidedService moduleProvidedService); + /** + * Visits a "uses" directive in a module declaration. + */ void visitCtUsedService(CtUsedService usedService); } diff --git a/src/main/java/spoon/reflect/visitor/chain/CtConsumer.java b/src/main/java/spoon/reflect/visitor/chain/CtConsumer.java index 7950e063360..7406870c8da 100644 --- a/src/main/java/spoon/reflect/visitor/chain/CtConsumer.java +++ b/src/main/java/spoon/reflect/visitor/chain/CtConsumer.java @@ -23,5 +23,6 @@ * @param - the type of accepted elements */ public interface CtConsumer { + /** Implement this method to do something with object "t" passed as parameter */ void accept(T t); } diff --git a/src/main/java/spoon/reflect/visitor/chain/CtFunction.java b/src/main/java/spoon/reflect/visitor/chain/CtFunction.java index c93a2e8c18a..4e12d1f5c72 100644 --- a/src/main/java/spoon/reflect/visitor/chain/CtFunction.java +++ b/src/main/java/spoon/reflect/visitor/chain/CtFunction.java @@ -25,5 +25,6 @@ * @param the type of the result of the function */ public interface CtFunction { + /** Implement this method to transform the input typed by T into an object of type R */ R apply(T input); } diff --git a/src/main/java/spoon/support/visitor/SignaturePrinter.java b/src/main/java/spoon/support/visitor/SignaturePrinter.java index 901ffafc7a5..e2022225e3d 100644 --- a/src/main/java/spoon/support/visitor/SignaturePrinter.java +++ b/src/main/java/spoon/support/visitor/SignaturePrinter.java @@ -53,6 +53,7 @@ public void visitCtExecutableReference(CtExecutableReference reference) { writeNameAndParameters(reference); } + /** writes only the name and parameters' types */ public void writeNameAndParameters(CtExecutableReference reference) { if (reference.isConstructor()) { write(reference.getDeclaringType().getQualifiedName()); diff --git a/src/main/java/spoon/testing/utils/ProcessorUtils.java b/src/main/java/spoon/testing/utils/ProcessorUtils.java index 89a8a186e73..208f157c592 100644 --- a/src/main/java/spoon/testing/utils/ProcessorUtils.java +++ b/src/main/java/spoon/testing/utils/ProcessorUtils.java @@ -42,6 +42,7 @@ public static void process(Factory factory, Collection> processors) compiler.process(processors); } + /** sets the fields of processor "p" given as parameter according to the properties */ public static void initProperties(Processor p, ProcessorProperties properties) { if (properties != null) { for (Field f : RtHelper.getAllFields(p.getClass())) {