You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/07/10 00:08:14 UTC

incubator-juneau-website git commit: Simplified syntax for annotations in HtmlDoc.

Repository: incubator-juneau-website
Updated Branches:
  refs/heads/asf-site 774b9a9cd -> de7a820f7


Simplified syntax for annotations in HtmlDoc.

Project: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/commit/de7a820f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/tree/de7a820f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/diff/de7a820f

Branch: refs/heads/asf-site
Commit: de7a820f7ebc229c5a6e9da81da50005ac4317d1
Parents: 774b9a9
Author: JamesBognar <ja...@apache.org>
Authored: Sun Jul 9 20:08:13 2017 -0400
Committer: JamesBognar <ja...@apache.org>
Committed: Sun Jul 9 20:08:13 2017 -0400

----------------------------------------------------------------------
 content/about.html | 80 ++++++++++++++++++++++++++-----------------------
 1 file changed, 42 insertions(+), 38 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/de7a820f/content/about.html
----------------------------------------------------------------------
diff --git a/content/about.html b/content/about.html
index fe38086..5c78854 100644
--- a/content/about.html
+++ b/content/about.html
@@ -222,9 +222,9 @@
 		.simple()  <jc>// Simple mode</jc>
 		.sq()  <jc>// Use single quotes</jc>
 		.pojoSwaps(   <jc>// Swap unserializable classes with surrogate POJOs</jc>
-			IteratorSwap.<jk>class</jk>,
-			ByteArrayBase64Swap.<jk>class</jk>,
-			CalendarSwap.ISO8601DT.<jk>class</jk>,
+			IteratorSwap.<jk>class</jk>, <jc>// Iterators swapped with lists</jc>
+			ByteArrayBase64Swap.<jk>class</jk>, <jc>// byte[] swapped with base-64 encoded strings</jc>
+			CalendarSwap.ISO8601DT.<jk>class</jk> <jc>// Calendars swapped with ISO8601-compliant strings</jc>
 		)
 		.beanFilters(MyBeanFilter.<jk>class</jk>)  <jc>// Control how bean properties are handled</jc>
 		.timeZone(TimeZone.<jsf>GMT</jsf>)  <jc>// For serializing Calendars</jc>
@@ -648,22 +648,25 @@
 		htmldoc=<ja>@HtmlDoc</ja>(
 			
 			<jc>// Custom navigation links.</jc>
-			links=<js>"{"</js>
-				+ <js>"up:'request:/..',"</js>
-				+ <js>"options:'servlet:/?method=OPTIONS',"</js>
-				+ <js>"form:'servlet:/formPage',"</js>
-				+ <js>"contentTypes:'$W{contentTypeMenuItem}',"</js>
-				+ <js>"source:'$C{Source/gitHub}/org/apache/juneau/examples/rest/SystemPropertiesResource.java'"</js>
-				+ <js>"}"</js>,
-	
+			links={
+				<js>"up: request:/.."</js>,
+				<js>"options: servlet:/?method=OPTIONS"</js>,
+				<js>"form: servlet:/formPage"</js>,
+				<js>"$W{contentTypeMenuItem}"</js>,
+				<js>"source: $C{Source/gitHub}/org/apache/juneau/examples/rest/SystemPropertiesResource.java"</js>
+			},
+			
 			<jc>// Custom page text in aside section.</jc>
-			aside=<js>""</js>
-				+ <js>"&lt;div style='max-width:800px' class='text'&gt;"</js>
-				+ <js>"	&lt;p&gt;Shows standard GET/PUT/POST/DELETE operations and use of Swagger annotations.&lt;/p&gt;"</js>
-				+ <js>"&lt;/div&gt;"</js>,
+			aside={
+				<js>"&lt;div style='max-width:800px' class='text'&gt;"</js>,
+				<js>"	&lt;p&gt;Shows standard GET/PUT/POST/DELETE operations and use of Swagger annotations.&lt;/p&gt;"</js>,
+				<js>"&lt;/div&gt;"</js>
+			},
 				
 			<jc>// Custom CSS styles applied to HTML view.</jc>
-			style=<js>"aside {display:table-caption;}"</js>
+			style={
+				<js>"aside {display:table-caption;}"</js>
+			}
 		),
 				
 		<jc>// Set serializer, parser, and REST context properties.</jc>
@@ -926,20 +929,21 @@
 			ContentTypeMenuItem.<jk>class</jk>
 		},
 		htmldoc=<ja>@HtmlDoc</ja>(
-			links=<js>"{"</js>
-				+ <js>"options:'?method=OPTIONS',"</js>
-				+ <js>"contentTypes:'$W{contentTypeMenuItem}',"</js>
-				+ <js>"source:'$C{Source/gitHub}/org/apache/juneau/examples/rest/RootResources.java'"</js>
-			+ <js>"}"</js>,
-			aside=<js>""</js>
-				+ <js>"&lt;div style='max-width:400px' class='text'&gt;"</js>
-				+ <js>"	&lt;p&gt;This is an example of a 'router' page that serves as a jumping-off point to child resources.&lt;/p&gt;"</js>
-				+ <js>"	&lt;p&gt;Resources can be nested arbitrarily deep through router pages.&lt;/p&gt;"</js>
-				+ <js>"	&lt;p&gt;Note the &lt;span class='link'&gt;OPTIONS&lt;/span&gt; link provided that lets you see the generated swagger doc for this page.&lt;/p&gt;"</js>
-				+ <js>"	&lt;p&gt;Also note the &lt;span class='link'&gt;SOURCE&lt;/span&gt; link on these pages to view the source code for the page.&lt;/p&gt;"</js>
-				+ <js>"	&lt;p&gt;All content on pages in the UI are serialized POJOs.  In this case, it's a serialized array of beans with 2 properties, 'name' and 'description'.&lt;/p&gt;"</js>
-				+ <js>"	&lt;p&gt;Other features (such as this aside) are added through annotations.&lt;/p&gt;"</js>
-				+ <js>"&lt;/div&gt;"</js>,
+			links={
+				<js>"options: ?method=OPTIONS"</js>,
+				<js>"$W{contentTypeMenuItem}"</js>,
+				<js>"source: $C{Source/gitHub}/org/apache/juneau/examples/rest/RootResources.java"</js>
+			},
+			aside={
+				<js>"&lt;div style='max-width:400px' class='text'&gt;"</js>,
+				<js>"	&lt;p&gt;This is an example of a 'router' page that serves as a jumping-off point to child resources.&lt;/p&gt;"</js>,
+				<js>"	&lt;p&gt;Resources can be nested arbitrarily deep through router pages.&lt;/p&gt;"</js>,
+				<js>"	&lt;p&gt;Note the options link provided that lets you see the generated swagger doc for this page.&lt;/p&gt;"</js>,
+				<js>"	&lt;p&gt;Also note the source link on these pages to view the source code for the page.&lt;/p&gt;"</js>,
+				<js>"	&lt;p&gt;All content on pages in the UI are serialized POJOs.  In this case, it's a serialized array of beans with 2 properties, 'name' and 'description'.&lt;/p&gt;"</js>,
+				<js>"	&lt;p&gt;Other features (such as this aside) are added through annotations.&lt;/p&gt;"</js>,
+				<js>"&lt;/div&gt;"</js>
+			},
 			footer=<js>"$W{poweredByApache}"</js>
 		),
 		children={
@@ -1061,14 +1065,14 @@
 		
 		<jc>// Add our menu items in the nav links.</jc>
 		htmldoc=<ja>@HtmlDoc</ja>(
-			links=<js>"{"</js>
-				+ <js>"up:'request:/..',"</js>
-				+ <js>"options:'servlet:/?method=OPTIONS',"</js>
-				+ <js>"query:'$W{queryMenuItem}',"</js>
-				+ <js>"contentTypes:'$W{contentTypeMenuItem}',"</js>
-				+ <js>"styles:'$W{styleMenuItem}',"</js>
-				+ <js>"source:'$C{Source/gitHub}/org/apache/juneau/examples/rest/PetStoreResource.java'"</js>
-			+ <js>"}"</js>
+			links={
+				<js>"up: request:/.."</js>,
+				<js>"options: servlet:/?method=OPTIONS"</js>,
+				<js>"$W{queryMenuItem}"</js>,
+				<js>"$W{contentTypeMenuItem}"</js>,
+				<js>"$W{styleMenuItem}"</js>,
+				<js>"source: $C{Source/gitHub}/org/apache/juneau/examples/rest/PetStoreResource.java"</js>
+			}
 		)
 	)
 	<jk>public</jk> Collection&lt;Pet&gt; getPets() {