You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2007/11/12 14:44:19 UTC
svn commit: r594127 - in
/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site:
apt/examples/jsdoc.apt apt/index.apt apt/screenshots.apt resources/
resources/images/ resources/images/jsdoc.png site.xml
Author: vsiveton
Date: Mon Nov 12 05:44:18 2007
New Revision: 594127
URL: http://svn.apache.org/viewvc?rev=594127&view=rev
Log:
o updated documentation
Added:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/examples/jsdoc.apt (with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/screenshots.apt (with props)
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/resources/
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/resources/images/
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/resources/images/jsdoc.png (with props)
Modified:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/index.apt
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/site.xml
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/examples/jsdoc.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/examples/jsdoc.apt?rev=594127&view=auto
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/examples/jsdoc.apt (added)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/examples/jsdoc.apt Mon Nov 12 05:44:18 2007
@@ -0,0 +1,39 @@
+ ------
+ JSdoc Java Example
+ ------
+ Vincent Siveton
+ ------
+ November 2007
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+JSdoc Java Example
+
+ Here is a simple example using Java:
+
++-----+
+ JSDoc jsDoc = new GenerateUMLDoc();
+ /* JSDoc jsDoc = (JSDoc) lookup( JSDoc.ROLE ); // Using Plexus */
+
+ // Generate
+ index.generate(jsDir, destDir );
++-----+
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/examples/jsdoc.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/examples/jsdoc.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/index.apt?rev=594127&r1=594126&r2=594127&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/index.apt (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/index.apt Mon Nov 12 05:44:18 2007
@@ -44,4 +44,8 @@
* Examples
- * {{{examples/ant.html}Ant}}: Some Ant example.
+ * {{{examples/ant.html}Using Ant}}: {{{http://ant.apache.org/}Ant}} tool examples to use it.
+
+ * {{{examples/jsdoc.html}Using Java}}: Java examples to generate JS documentation.
+
+ []
\ No newline at end of file
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/screenshots.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/screenshots.apt?rev=594127&view=auto
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/screenshots.apt (added)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/screenshots.apt Mon Nov 12 05:44:18 2007
@@ -0,0 +1,31 @@
+ ------
+ Screenshots
+ ------
+ Vincent Siveton
+ ------
+ November 2007
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+Maven JSDoc Screenshots
+
+[./images/jsdoc.png] JSDoc sample
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/screenshots.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/apt/screenshots.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Added: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/resources/images/jsdoc.png
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/resources/images/jsdoc.png?rev=594127&view=auto
==============================================================================
Binary file - no diff available.
Propchange: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/resources/images/jsdoc.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/site.xml?rev=594127&r1=594126&r2=594127&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/site.xml (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-js/src/site/site.xml Mon Nov 12 05:44:18 2007
@@ -72,10 +72,12 @@
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Further Links" href="links.html"/>
+ <item name="Screenshots" href="screenshots.html"/>
</menu>
<menu name="Examples">
- <item name="Using Maven JXR JS with Ant" href="/examples/ant.html"/>
+ <item name="With Ant" href="/examples/ant.html"/>
+ <item name="With Java" href="/examples/jsdoc.html"/>
</menu>
<menu ref="reports"/>