Changeset 35

Timestamp:

05/08/11 19:32:17 (13 years ago)

Author:

phdmakk

Message:

+ added optional check for required @desc tags in function definitions

Location:

trunk/t3d/src

Files:

• elements/TTCN3Comment.java (modified) (2 diffs)
• elements/TTCN3Element.java (modified) (1 diff)
• org/etsi/t3d/config/DocumentationProfile.java (modified) (2 diffs)

trunk/t3d/src/elements/TTCN3Comment.java

@@ -116 +116 @@
                                 }
 
+                                if (T3D.activeProfile.isCheckFunctionDescTagsRequired())
+                                if (elementType != TTCN3ParserTokenTypes.FunctionDef
+//                                              && elementType != TTCN3ParserTokenTypes.TestcaseDef
+//                                              && elementType != TTCN3ParserTokenTypes.AltstepDef
+                                                && desc.size() <= 0) {
+                                        warnings.add(getWarningMissingTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getDescTag()));
+                                }
+
+                                
                                 for (String d : desc)
                                         if (d.length() <= 0)
@@ -179 +188 @@
                 return "Empty tag found: " + tagname;
         }
-        
+
+        private String getWarningMissingTags(String tagname){
+                return "Required " + tagname + " tag is missing";
+        }
+
         
         private String getIdentifier(String comment, int pos){

trunk/t3d/src/elements/TTCN3Element.java

@@ -36 +36 @@
                 this.paramView = paramView;
                 this.path = path;
-                
-                
                 
                 for(String warning : comment.getWarnings()) {

trunk/t3d/src/org/etsi/t3d/config/DocumentationProfile.java

@@ -11 +11 @@
         private boolean showOriginalT3DocTags = false;
         private boolean checkUndocumentedParameters = true;
+        private boolean checkFunctionDescTagsRequired = false;
+
         private boolean checkConsistentTagUsage = true;
         private boolean checkIdenticalDescriptionTags = true;
@@ -126 +128 @@
                 return commentTagsConfiguration;
         }
+        public boolean isCheckFunctionDescTagsRequired() {
+                return checkFunctionDescTagsRequired;
+        }
+
+        public void setCheckFunctionDescTagsRequired(
+                        boolean checkFunctionDescTagsRequired) {
+                this.checkFunctionDescTagsRequired = checkFunctionDescTagsRequired;
+        }
+
 }