Merge pull request #116 from d3scomp/newgen-iliasg

javadoc added in AnnotationProcessorException
d3scomp · Nov 21, 2013 · c61e36e · c61e36e
2 parents a12597a + 7a77e69
commit c61e36e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/jdeeco-core/src/cz/cuni/mff/d3s/deeco/annotations/processor/AnnotationProcessor.java b/jdeeco-core/src/cz/cuni/mff/d3s/deeco/annotations/processor/AnnotationProcessor.java
@@ -23,8 +23,7 @@
 import cz.cuni.mff.d3s.deeco.model.runtime.meta.RuntimeMetadataFactory;
 
 /**
- * Common gateway for processing of Java source code classes with DEECo
- * annotations.
+ * Common gateway for processing of Java objects/classes with DEECo annotations.
  * <p>
  * "Processing" means parsing the file, creating an Ecore subgraph out of it,
  * attaching the subgraph to the top-level container, the "runtimeMetadata"

diff --git a/...co-core/src/cz/cuni/mff/d3s/deeco/annotations/processor/AnnotationProcessorException.java b/...co-core/src/cz/cuni/mff/d3s/deeco/annotations/processor/AnnotationProcessorException.java
@@ -1,5 +1,14 @@
 package cz.cuni.mff.d3s.deeco.annotations.processor;
 
+/**
+ * Thrown when processing of DEECo-annotated Java object(s)/class(es) fails.
+ * <p>
+ * The message should encode all relevant information (class name, method name, parameter index, ...) to pinpoint the problem. 
+ * </p>
+ * 
+ * @author Ilias Gerostathopoulos <iliasg@d3s.mff.cuni.cz>
+ *
+ */
 public class AnnotationProcessorException extends Exception {
 
 	private static final long serialVersionUID = 1L;