svn commit: r1570081 - /myfaces/core/branches/2.1.x/impl/src/main/resources/META-INF/xdoc-web-config.vm

[lu...@apache.org]

Author: lu4242
Date: Thu Feb 20 04:04:30 2014
New Revision: 1570081

URL: http://svn.apache.org/r1570081
Log:
fix documentation (create table for deprecated web config parameters)

Modified:
    myfaces/core/branches/2.1.x/impl/src/main/resources/META-INF/xdoc-web-config.vm

Modified: myfaces/core/branches/2.1.x/impl/src/main/resources/META-INF/xdoc-web-config.vm
URL: http://svn.apache.org/viewvc/myfaces/core/branches/2.1.x/impl/src/main/resources/META-INF/xdoc-web-config.vm?rev=1570081&r1=1570080&r2=1570081&view=diff
==============================================================================
--- myfaces/core/branches/2.1.x/impl/src/main/resources/META-INF/xdoc-web-config.vm (original)
+++ myfaces/core/branches/2.1.x/impl/src/main/resources/META-INF/xdoc-web-config.vm Thu Feb 20 04:04:30 2014
@@ -79,6 +79,7 @@ $baseContent
 #set ($webConfigGroupsLabel = {"resources" : "Resources (resource)", 
                                "validation" : "Conversion and Validation (validation)", 
                                "state" : "State Saving (state)",
+                               "cdi" : "CDI (cdi)",
                                "EL" : "Expression Language (EL)",
                                "viewhandler" : "View Handling (viewhandler)",
                                "render" : "Rendering (render)"} )
@@ -101,6 +102,7 @@ $baseContent
 #if ($modelIds.contains($webConfig.modelId))
 #set ($webConfigParamList = ${webConfig.getWebConfigParametersList()})
 #foreach( $webConfigParam in $webConfigParamList )
+#if (!$webConfigParam.deprecated)
 #if (not $webConfigParam.containsTag('tomahawk'))
 #if ($webConfigParam.group == $webConfigGroup)
 #writeWebConfigParamRow($webConfigParam)
@@ -109,6 +111,7 @@ $baseContent
 #end
 #end
 #end
+#end
 </table>
 #end
 
@@ -125,6 +128,7 @@ $baseContent
 #if ($modelIds.contains($webConfig.modelId))
 #set ($webConfigParamList = ${webConfig.getWebConfigParametersList()})
 #foreach( $webConfigParam in $webConfigParamList )
+#if (!$webConfigParam.deprecated)
 #if (not $webConfigParam.containsTag('tomahawk'))
 #if (!$webConfigParam.group)
 #writeWebConfigParamRow($webConfigParam)
@@ -135,6 +139,30 @@ $baseContent
 #end
 #end
 #end
+#end
+</table>
+
+  <p><b>Deprecated Parameters</b></p>
+<table>
+ <tr>
+  <th>Name</th>
+  <th>Since</th>
+  <th>Default Value</th>
+  <th>Short Description</th>
+ </tr>
+#set ($webConfigList = ${model.getWebConfigs()})
+#foreach( $webConfig in $webConfigList )
+#if ($modelIds.contains($webConfig.modelId))
+#set ($webConfigParamList = ${webConfig.getWebConfigParametersList()})
+#foreach( $webConfigParam in $webConfigParamList )
+#if ($webConfigParam.deprecated)
+#if (not $webConfigParam.containsTag('tomahawk'))
+#writeWebConfigParamRow($webConfigParam)
+#end
+#end
+#end
+#end
+#end
 </table>
   </section>
   <section name="Detailed Information">
@@ -150,10 +178,16 @@ $baseContent
   <p>
     <b>Param Name:</b> <a name="$webConfigParam.name.replace('.','_')">$webConfigParam.name</a>
     <br/>
+    <b>Ignore Upper/Lower case values:</b> $webConfigParam.isIgnoreUpperLowerCase()
+    <br/>
 #if ($webConfigParam.defaultValue)
     <b>Default Value:</b> $webConfigParam.defaultValue
     <br/>
 #end
+#if ($webConfigParam.deprecated)
+    <b>Deprecated:</b> $webConfigParam.isDeprecated()
+    <br/>
+#end
 #if ($webConfigParam.expectedValues)
     <b>Expected Values:</b> $webConfigParam.expectedValues
     <br/>