Changes between Version 1 and Version 2 of Documentation/T3D/Log-Output/Warnings

Timestamp:

05/08/11 19:27:45 (14 years ago)

Author:

phdmakk

Comment:

--

Documentation/T3D/Log-Output/Warnings

@@ -90 +90 @@
 ==== Undocumented Parameters ====
 
-Formal parameters shall be described by means of the corresponding @param tags. If this is not the case and if '''showUndocumentedParameters''' is enabled in the configuration profile, a warning will be thrown.
+Formal parameters shall be described by means of the corresponding @param tags. If this is not the case and if '''checkUndocumentedParameters''' is enabled in the configuration profile, a warning will be thrown.
 
 '''Example'''
@@ -108 +108 @@
 }}}
 
-'''Note:''' There are more subtle details related to the (proper) documentation of formal parameters. In future considerations, these subtleties may be implemented more throroughly.  
+'''Note:''' There are more subtle details related to the (proper) documentation of formal parameters. In future considerations, these subtleties may be implemented more thoroughly.  
+
+==== Required @desc Tags for Functions ====
+
+If enabled ('''checkFunctionDescTagsRequired''' configuration flag, disabled by default), this check will throw warnings if there are no @desc tags present for a function definition.
+
+'''Example'''
+{{{
+/*
+ * @param a Description of Parameter a
+*/
+function f1(integer a){
+     ...
+}
+}}}
+
+will result in
+
+{{{
+testFile.ttcn: 31: WARNING: Code Documentation: Required @desc tag not missing
+}}}
+
 
 ==== Documented But Nonexistent Parameters ====
@@ -133 +154 @@
 ==== Cyclic Imports ====
 
-In adition to the pure documentation-related checks, there is currently also a cyclic imports check, which throws warnings if cyclic imports occur. This is of particular importance for the import view, since cyclic dependencies will be impossible to represent with the current presentation format. Cyclic imports shall also be detected by most compilers since there are a lot more problems associated with them. The warning contains the cyclic import and there is a separate warning for each module that is part of the cycle.
+In addition to the pure documentation-related checks, there is currently also a cyclic imports check, which throws warnings if cyclic imports occur. This is of particular importance for the import view, since cyclic dependencies will be impossible to represent with the current presentation format. Cyclic imports shall also be detected by most compilers since there are a lot more problems associated with them. The warning contains the cyclic import and there is a separate warning for each module that is part of the cycle.
 
 '''Example'''