Skip to content

Commit

Permalink
Eliminate jstructural
Browse files Browse the repository at this point in the history
  • Loading branch information
io7m committed May 4, 2024
1 parent d1a7a13 commit f34b7d2
Show file tree
Hide file tree
Showing 19 changed files with 2,265 additions and 2,613 deletions.
84 changes: 25 additions & 59 deletions com.io7m.jcamera.documentation/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@

<properties>
<mdep.analyze.skip>true</mdep.analyze.skip>
<checkstyle.skip>true</checkstyle.skip>
<bnd.baseline.skip>true</bnd.baseline.skip>
</properties>

<dependencies>
Expand Down Expand Up @@ -87,8 +89,7 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>

<!-- Unpack sources into JavaDoc sources. -->
<!-- Unpack sources into example sources. -->
<execution>
<id>unpack-sources-javadoc</id>
<phase>package</phase>
Expand All @@ -100,11 +101,9 @@
<includeGroupIds>${project.groupId}</includeGroupIds>
<classifier>sources</classifier>
<failOnMissingClassifierArtifact>false</failOnMissingClassifierArtifact>
<outputDirectory>${project.build.directory}/javadoc-sources</outputDirectory>
<outputDirectory>${project.build.directory}/example-sources</outputDirectory>
</configuration>
</execution>

<!-- Also unpack sources into documentation. -->
<execution>
<id>unpack-sources-documentation</id>
<phase>package</phase>
Expand All @@ -119,108 +118,75 @@
<outputDirectory>${project.build.directory}/documentation/</outputDirectory>
</configuration>
</execution>

<execution>
<id>make-classpath</id>
<phase>package</phase>
<goals>
<goal>build-classpath</goal>
</goals>
<configuration>
<outputFile>${project.build.directory}/javadoc-classpath</outputFile>
</configuration>
</execution>
</executions>
</plugin>

<!-- Javadoc handling -->
<!-- Generate split example code -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<executions>
<!-- Generate split example code -->
<execution>
<id>make-example-sim</id>
<id>make-example-main</id>
<phase>package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<mainClass>com.io7m.jcamera.documentation.ExampleSplitMain</mainClass>
<arguments>
<argument>${project.build.directory}/javadoc-sources/com/io7m/jcamera/examples/jogl/ExampleFPSStyleSimulation.java</argument>
<argument>${project.build.directory}/example-sources/com/io7m/jcamera/examples/jogl/ExampleFPSStyleMain.java</argument>
<argument>${project.build.directory}/documentation/</argument>
<argument>example-fps-sim-</argument>
<argument>example-fps-main-</argument>
</arguments>
</configuration>
</execution>

<!-- Generate split example code -->
<execution>
<id>make-example-main</id>
<id>make-example-sim</id>
<phase>package</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<mainClass>com.io7m.jcamera.documentation.ExampleSplitMain</mainClass>
<arguments>
<argument>${project.build.directory}/javadoc-sources/com/io7m/jcamera/examples/jogl/ExampleFPSStyleMain.java</argument>
<argument>${project.build.directory}/example-sources/com/io7m/jcamera/examples/jogl/ExampleFPSStyleSimulation.java</argument>
<argument>${project.build.directory}/documentation/</argument>
<argument>example-fps-main-</argument>
</arguments>
</configuration>
</execution>

<!-- Generate JavaDoc -->
<execution>
<goals>
<goal>java</goal>
</goals>
<phase>package</phase>
<configuration>
<mainClass>com.io7m.primogenitor.support.TrivialJavadoc</mainClass>
<arguments>
<argument>${project.build.directory}/javadoc-sources</argument>
<argument>${project.build.directory}/javadoc-classpath</argument>
<argument>${project.build.directory}/documentation/apidocs</argument>
<argument>${project.build.directory}/javadoc-log.txt</argument>
<argument>${project.build.directory}/javadoc-options</argument>
<argument>example-fps-sim-</argument>
</arguments>
</configuration>
</execution>
</executions>
</plugin>

<!-- Produce documentation -->
<!-- Generate documentation in various formats. -->
<plugin>
<groupId>com.io7m.jstructural</groupId>
<artifactId>io7m-jstructural-maven-plugin</artifactId>
<groupId>com.io7m.xstructural</groupId>
<artifactId>com.io7m.xstructural.maven_plugin</artifactId>
<version>${com.io7m.xstructural.version}</version>
<executions>
<execution>
<id>make-documentation-single</id>
<id>xhtml-single</id>
<phase>package</phase>
<goals>
<goal>transform</goal>
<goal>xhtml-single</goal>
</goals>
<configuration>
<documentFile>${project.build.directory}/documentation/documentation.xml</documentFile>
<outputDirectory>${project.build.directory}/documentation/</outputDirectory>
<brandFile>${project.build.directory}/documentation/brand.xml</brandFile>
<pagination>XHTML_SINGLE</pagination>
<brandingFile>${project.build.directory}/documentation/brand.xml</brandingFile>
<sourceFile>${project.build.directory}/documentation/main.xml</sourceFile>
<outputDirectory>${project.build.directory}/documentation</outputDirectory>
</configuration>
</execution>
<execution>
<id>make-documentation-multi</id>
<id>xhtml-multi</id>
<phase>package</phase>
<goals>
<goal>transform</goal>
<goal>xhtml-multi</goal>
</goals>
<configuration>
<documentFile>${project.build.directory}/documentation/documentation.xml</documentFile>
<outputDirectory>${project.build.directory}/documentation/</outputDirectory>
<brandFile>${project.build.directory}/documentation/brand.xml</brandFile>
<pagination>XHTML_MULTI</pagination>
<brandingFile>${project.build.directory}/documentation/brand.xml</brandingFile>
<sourceFile>${project.build.directory}/documentation/main.xml</sourceFile>
<outputDirectory>${project.build.directory}/documentation</outputDirectory>
</configuration>
</execution>
</executions>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@
<directory>${project.build.directory}/documentation</directory>
<outputDirectory>/</outputDirectory>
</fileSet>
<fileSet>
<directory>${project.build.directory}/site/apidocs</directory>
<outputDirectory>/apidocs</outputDirectory>
</fileSet>
</fileSets>
</assembly>

Original file line number Diff line number Diff line change
@@ -1,10 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<div class="brand" xmlns="http://www.w3.org/1999/xhtml">
<div class="brand_left">
<a href="http://io7m.com/">io7m</a>
<?xml version="1.0" encoding="UTF-8" ?>

<!--
Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-->

<div xmlns="http://www.w3.org/1999/xhtml"
class="brandingContainer">
<div class="branding">
<a href="https://www.io7m.com/">io7m</a> |
<a href="index.xhtml">single-page</a> |
<a href="index-m.xhtml">multi-page</a> |
jcamera User Manual ${project.version}
</div>
<div class="brand_right">
<a href="${project.parent.url}">${project.parent.name}</a>
${project.version}
</div>
</div>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>

<div xmlns="http://www.w3.org/1999/xhtml">
<h2>License</h2>
<p class="stParagraph">
Copyright © 2023 Mark Raynsford &lt;code@io7m.com&gt; https://www.io7m.com
</p>
<p class="stParagraph">
This book is placed into the public domain for free use by anyone for any purpose. It may be freely used, modified,
and distributed.
</p>
<p class="stParagraph">
In jurisdictions that do not recognise the public domain this book may be freely used, modified, and distributed
without restriction.
</p>
<p class="stParagraph">
This book comes with absolutely no warranty.
</p>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
/*
* Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
* IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

.brandingContainer
{
margin: 1em;
}

.branding
{
font-family: monospace;
font-size: 80%;
}

.command,
.constant,
.expression,
.file,
.function,
.package,
.language,
.parameter,
.statement,
.type,
.variable
{
font-family: monospace;
}

.term
{
font-style: italic;
}

.parameterType {
font-family: monospace;
}
.parameterValue {
font-family: monospace;
}

.parametersTable tr
{

}
.parametersTable th
{
text-align: left;
padding: 0.5em;
}
.parametersTable td
{
vertical-align: top;
hyphens: auto;
padding: 0.5em;
border-top: 1px solid #eee;
border-right: 1px solid #eee;
}
.parametersTable td:nth-child(1)
{
hyphens: none;
}
.parametersTable td:nth-child(2)
{

}
.parametersTable td:nth-child(3)
{

}
.parametersTable td:nth-child(4)
{

}
.parametersTable td:last-child
{
border-right: none;
}

.valueTable th
{
text-align: left;
padding: 0.5em;
}
.valueTable td
{
padding: 0.5em;
border-top: 1px solid #eee;
border-right: 1px solid #eee;
vertical-align: top;
}
.valueTable td:nth-child(1)
{
width: 8em;
}
.valueTable td:nth-child(2)
{

}
.valueTable td:last-child
{
border-right: none;
}

.genericTable th
{
text-align: left;
padding: 0.5em;
}
.genericTable td
{
padding: 0.5em;
border-top: 1px solid #eee;
border-right: 1px solid #eee;
vertical-align: top;
}
.genericTable td:nth-child(1)
{
width: 8em;
}
.genericTable td:nth-child(2)
{

}
.genericTable td:last-child
{
border-right: none;
}
Loading

0 comments on commit f34b7d2

Please sign in to comment.