flex-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cd...@apache.org
Subject git commit: [flex-falcon] [refs/heads/develop] - - Enabled the asciidoctor site generation (including code-highlighting and image creation)
Date Mon, 01 Aug 2016 07:55:20 GMT
Repository: flex-falcon
Updated Branches:
  refs/heads/develop 1130f934b -> 2c3a1c058


- Enabled the asciidoctor site generation (including code-highlighting and image creation)


Project: http://git-wip-us.apache.org/repos/asf/flex-falcon/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-falcon/commit/2c3a1c05
Tree: http://git-wip-us.apache.org/repos/asf/flex-falcon/tree/2c3a1c05
Diff: http://git-wip-us.apache.org/repos/asf/flex-falcon/diff/2c3a1c05

Branch: refs/heads/develop
Commit: 2c3a1c058272bb850613e9e068b5c94ad49f9f51
Parents: 1130f93
Author: Christofer Dutz <christofer.dutz@codecentric.de>
Authored: Mon Aug 1 09:55:11 2016 +0200
Committer: Christofer Dutz <christofer.dutz@codecentric.de>
Committed: Mon Aug 1 09:55:11 2016 +0200

----------------------------------------------------------------------
 compiler-build-tools/pom.xml                    |  44 ++++++
 compiler-jx/src/site/asciidoc/docs.adoc         |  18 +++
 compiler-test-utils/src/site/asciidoc/docs.adoc |  18 +++
 compiler/src/site/asciidoc/docs.adoc            |  18 +++
 debugger/src/site/asciidoc/docs.adoc            |  18 +++
 flex-compiler-oem/src/site/asciidoc/docs.adoc   |  18 +++
 flexjs-ant-tasks/src/site/asciidoc/docs.adoc    |  18 +++
 flexjs-maven-plugin/src/site/asciidoc/docs.adoc |  18 +++
 pom.xml                                         | 150 +++++++++----------
 src/site/asciidoc/structure.adoc                |  26 ++--
 src/site/site.xml                               |   1 +
 11 files changed, 252 insertions(+), 95 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/2c3a1c05/compiler-build-tools/pom.xml
----------------------------------------------------------------------
diff --git a/compiler-build-tools/pom.xml b/compiler-build-tools/pom.xml
index 93fb55c..932b3d1 100644
--- a/compiler-build-tools/pom.xml
+++ b/compiler-build-tools/pom.xml
@@ -60,9 +60,53 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.10.4</version>
+      </plugin>
     </plugins>
   </build>
 
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.10.4</version>
+        <configuration>
+          <tags>
+            <tag>
+              <name>goal</name>
+              <placement>a</placement>
+              <head>Goal:</head>
+            </tag>
+            <tag>
+              <name>phase</name>
+              <placement>a</placement>
+              <head>Phase:</head>
+            </tag>
+            <tag>
+              <name>threadSafe</name>
+              <placement>a</placement>
+              <head>Thread Safe:</head>
+            </tag>
+            <tag>
+              <name>requiresDependencyResolution</name>
+              <placement>a</placement>
+              <head>Requires Dependency Resolution:</head>
+            </tag>
+            <tag>
+              <name>requiresProject</name>
+              <placement>a</placement>
+              <head>Requires Project:</head>
+            </tag>
+          </tags>
+        </configuration>
+      </plugin>
+    </plugins>
+  </reporting>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>

http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/2c3a1c05/compiler-jx/src/site/asciidoc/docs.adoc
----------------------------------------------------------------------
diff --git a/compiler-jx/src/site/asciidoc/docs.adoc b/compiler-jx/src/site/asciidoc/docs.adoc
new file mode 100644
index 0000000..2253e32
--- /dev/null
+++ b/compiler-jx/src/site/asciidoc/docs.adoc
@@ -0,0 +1,18 @@
+////
+
+  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.
+
+////

http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/2c3a1c05/compiler-test-utils/src/site/asciidoc/docs.adoc
----------------------------------------------------------------------
diff --git a/compiler-test-utils/src/site/asciidoc/docs.adoc b/compiler-test-utils/src/site/asciidoc/docs.adoc
new file mode 100644
index 0000000..2253e32
--- /dev/null
+++ b/compiler-test-utils/src/site/asciidoc/docs.adoc
@@ -0,0 +1,18 @@
+////
+
+  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.
+
+////

http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/2c3a1c05/compiler/src/site/asciidoc/docs.adoc
----------------------------------------------------------------------
diff --git a/compiler/src/site/asciidoc/docs.adoc b/compiler/src/site/asciidoc/docs.adoc
new file mode 100644
index 0000000..2253e32
--- /dev/null
+++ b/compiler/src/site/asciidoc/docs.adoc
@@ -0,0 +1,18 @@
+////
+
+  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.
+
+////

http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/2c3a1c05/debugger/src/site/asciidoc/docs.adoc
----------------------------------------------------------------------
diff --git a/debugger/src/site/asciidoc/docs.adoc b/debugger/src/site/asciidoc/docs.adoc
new file mode 100644
index 0000000..2253e32
--- /dev/null
+++ b/debugger/src/site/asciidoc/docs.adoc
@@ -0,0 +1,18 @@
+////
+
+  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.
+
+////

http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/2c3a1c05/flex-compiler-oem/src/site/asciidoc/docs.adoc
----------------------------------------------------------------------
diff --git a/flex-compiler-oem/src/site/asciidoc/docs.adoc b/flex-compiler-oem/src/site/asciidoc/docs.adoc
new file mode 100644
index 0000000..2253e32
--- /dev/null
+++ b/flex-compiler-oem/src/site/asciidoc/docs.adoc
@@ -0,0 +1,18 @@
+////
+
+  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.
+
+////

http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/2c3a1c05/flexjs-ant-tasks/src/site/asciidoc/docs.adoc
----------------------------------------------------------------------
diff --git a/flexjs-ant-tasks/src/site/asciidoc/docs.adoc b/flexjs-ant-tasks/src/site/asciidoc/docs.adoc
new file mode 100644
index 0000000..2253e32
--- /dev/null
+++ b/flexjs-ant-tasks/src/site/asciidoc/docs.adoc
@@ -0,0 +1,18 @@
+////
+
+  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.
+
+////

http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/2c3a1c05/flexjs-maven-plugin/src/site/asciidoc/docs.adoc
----------------------------------------------------------------------
diff --git a/flexjs-maven-plugin/src/site/asciidoc/docs.adoc b/flexjs-maven-plugin/src/site/asciidoc/docs.adoc
new file mode 100644
index 0000000..2253e32
--- /dev/null
+++ b/flexjs-maven-plugin/src/site/asciidoc/docs.adoc
@@ -0,0 +1,18 @@
+////
+
+  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.
+
+////

http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/2c3a1c05/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 03021a8..06ece24 100644
--- a/pom.xml
+++ b/pom.xml
@@ -393,29 +393,6 @@
         </configuration>
       </plugin>
 
-      <!-- Configure the assembly -->
-      <!--plugin>
-          <artifactId>maven-assembly-plugin</artifactId>
-          <version>2.6</version>
-          <executions>
-              <execution>
-                  <id>assemble-sources-releases</id>
-                  <phase>package</phase>
-                  <goals>
-                      <goal>single</goal>
-                  </goals>
-              </execution>
-          </executions>
-          <configuration>
-              <descriptors>
-                  <descriptor>src/assembly/binary-distribution-zip.xml</descriptor>
-                  <descriptor>src/assembly/binary-distribution-gz.xml</descriptor>
-                  <descriptor>src/assembly/source-distribution-zip.xml</descriptor>
-                  <descriptor>src/assembly/source-distribution-gz.xml</descriptor>
-              </descriptors>
-          </configuration>
-      </plugin-->
-
       <!-- Configure the Site generation -->
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -428,61 +405,55 @@
           <locales>en</locales>
           <inputEncoding>${project.build.sourceEncoding}</inputEncoding>
           <outputEncoding>${project.reporting.outputencoding}</outputEncoding>
+          <!-- Configure the asciidoctor configuration -->
+          <asciidoc>
+            <sourceDirectory>src/site/asciidoc</sourceDirectory>
+            <requires>
+              <require>asciidoctor-diagram</require>
+            </requires>
+            <backend>html5</backend>
+            <attributes>
+              <toc>left</toc>
+              <toclevels>2</toclevels>
+              <icons>font</icons>
+              <imagesdir>${project.build.directory}/site/images</imagesdir>
+              <sectanchors>true</sectanchors>
+              <idprefix/>
+              <idseparator>-</idseparator>
+              <source-highlighter>coderay</source-highlighter>
+              <coderay-css>style</coderay-css>
+            </attributes>
+          </asciidoc>
         </configuration>
         <dependencies>
+          <!-- All dependencies needed by asciidoctor -->
           <dependency>
             <groupId>org.asciidoctor</groupId>
             <artifactId>asciidoctor-maven-plugin</artifactId>
             <version>1.5.3</version>
           </dependency>
-        </dependencies>
-      </plugin>
-
-      <plugin>
-        <groupId>org.asciidoctor</groupId>
-        <artifactId>asciidoctor-maven-plugin</artifactId>
-        <version>1.5.3</version>
-        <dependencies>
+          <dependency>
+            <groupId>org.jruby</groupId>
+            <artifactId>jruby-complete</artifactId>
+            <version>1.7.21</version>
+          </dependency>
+          <dependency>
+            <groupId>org.asciidoctor</groupId>
+            <artifactId>asciidoctorj</artifactId>
+            <version>1.5.4</version>
+          </dependency>
           <dependency>
             <groupId>org.asciidoctor</groupId>
             <artifactId>asciidoctorj-diagram</artifactId>
             <version>1.3.1</version>
           </dependency>
         </dependencies>
-        <configuration>
-          <requires>
-            <require>asciidoctor-diagram</require>
-          </requires>
-          <attributes>
-            <!-- Example below shows how to specify in this pom instead of System's PATH,
the location of dot command of Graphviz, required by PlantUML libraries -->
-            <!-- Windows:
-                <graphvizdot>C:\Program Files (x86)\Graphviz2.38\bin\dot.exe</graphvizdot>
-            -->
-            <!-- *nix :
-                <graphvizdot>/usr/local/bin/dot</graphvizdot>
-            -->
-          </attributes>
-        </configuration>
-        <!--executions>
-            <execution>
-                <id>generate-html-doc</id>
-                <phase>generate-resources</phase>
-                <goals>
-                    <goal>process-asciidoc</goal>
-                </goals>
-                <configuration>
-                    <backend>html5</backend>
-                    <attributes>
-                        <imagesdir>./images</imagesdir>
-                        <toc>left</toc>
-                        <icons>font</icons>
-                        <sectanchors>true</sectanchors>
-                        <idprefix/>
-                        <idseparator>-</idseparator>
-                    </attributes>
-                </configuration>
-            </execution>
-        </executions-->
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.10.4</version>
       </plugin>
 
       <plugin>
@@ -495,20 +466,6 @@
 
   <reporting>
     <plugins>
-      <!-- Process the asciidoctor resources in the src/site/asciidoc directory -->
-      <plugin>
-        <groupId>org.asciidoctor</groupId>
-        <artifactId>asciidoctor-maven-plugin</artifactId>
-        <version>1.5.3</version>
-        <configuration>
-          <attributes>
-            <icons>font</icons>
-            <source-highlighter>coderay</source-highlighter>
-            <coderay-css>style</coderay-css>
-            <toclevels>2</toclevels>
-          </attributes>
-        </configuration>
-      </plugin>
 
       <!-- Generates a changelog report from GIT commits -->
       <plugin>
@@ -544,9 +501,38 @@
 
       <!-- Generate the JavaDoc API documentation -->
       <!--plugin>
-          <groupId>org.apache.maven.plugins</groupId>
-          <artifactId>maven-javadoc-plugin</artifactId>
-          <version>2.10.3</version>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.10.4</version>
+        <configuration>
+          <tags>
+            <tag>
+              <name>goal</name>
+              <placement>a</placement>
+              <head>Goal:</head>
+            </tag>
+            <tag>
+              <name>phase</name>
+              <placement>a</placement>
+              <head>Phase:</head>
+            </tag>
+            <tag>
+              <name>threadSafe</name>
+              <placement>a</placement>
+              <head>Thread Safe:</head>
+            </tag>
+            <tag>
+              <name>requiresDependencyResolution</name>
+              <placement>a</placement>
+              <head>Requires Dependency Resolution:</head>
+            </tag>
+            <tag>
+              <name>requiresProject</name>
+              <placement>a</placement>
+              <head>Requires Project:</head>
+            </tag>
+          </tags>
+        </configuration>
       </plugin-->
     </plugins>
   </reporting>

http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/2c3a1c05/src/site/asciidoc/structure.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/structure.adoc b/src/site/asciidoc/structure.adoc
index ed8d624..0c3cc6a 100644
--- a/src/site/asciidoc/structure.adoc
+++ b/src/site/asciidoc/structure.adoc
@@ -30,42 +30,42 @@
     | +--------------------------------------+   +-------------------------------------------+
     | |                                      |   |                                      
    |
     | | compiler-build-tools                 |   | compiler-build-tools                 
    |
-    | | -> generate-problems-resource-bundle |   | -> generate-problems-enum      
          |
+    | | * generate-problems-resource-bundle  |   | * generate-problems-enum             
    |
     | |                                      |   |                                      
    |
     | +-------------------+------------------+   +---------------+---------------------------+
     |                     |                                      |
-    |                     |                                      |
-  +-v-------------------+ | +----------------------------------+ | +-------------------------+
+    v                     |                                      |
+  +---------------------+ | +----------------------------------+ | +-------------------------+
   |                     | | |                                  | | |                    
    |
   | jburg-maven-plugin  | | | compiler-build-tools             | | | compiler-build-tools
   |
-  |                     | | | -> generate-unknown-tree-handler | | | -> add-class-annotation
|
+  |                     | | | * generate-unknown-tree-handler  | | | * add-class-annotation
 |
   |                     | | |                                  | | |                    
    |
   +----------+----------+ | +----------------+-----------------+ | +------------+------------+
              |            |                  |                   |              |
-             |            |                  |                   |              |
-  +----------v------------v------------------v-------------------v--------------v------------+
+             v            v                  v                   v              v
+  +------------------------------------------------------------------------------------------+
   |                                                                                     
    |
   | compiler                                                                            
    |
   |                                                                                     
    |
   +---------------------------------------------+--------------------------------------------+
                                                 |
-                                                |
-  +---------------------------------------------v--------------------------------------------+
+                                                v
+  +------------------------------------------------------------------------------------------+
   |                                                                                     
    |
   | compiler-jx                                                                         
    |
   |                                                                                     
    |
   +-----------------------------+------------------------------------------------------------+
                                 |
-                                |
-  +-----------------------------v-------------------------------+   +------------------------+
+                                v
+  +-------------------------------------------------------------+   +------------------------+
   |                                                             |   |                   
    |
   | flexjs-maven-plugin                                         |   | compiler-build-tools
  |
-  |                                                             |   | -> pre-process-sources
|
+  |                                                             |   | * pre-process-sources
 |
   +-----------------------------+-------------------------------+   |                   
    |
                                 |                                   +------------+-----------+
                                 |                                                |
-                                |                                                |
-  +-----------------------------v------------------------------------------------v-----------+
+                                v                                                v
+  +------------------------------------------------------------------------------------------+
   |                                                                                     
    |
   | Extern Module                                                                       
    |
   |                                                                                     
    |

http://git-wip-us.apache.org/repos/asf/flex-falcon/blob/2c3a1c05/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index 295640c..64df894 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -51,6 +51,7 @@
 
             <!-- Generated from src/site/asciidoc/build.adoc -->
             <item name="Building from Source" href="build.html"/>
+            <item name="Build structure" href="structure.html"/>
         </menu>
 
         <menu ref="reports" />


Mime
View raw message