From 2dcea6b53767801381414f767cc827fbbc116cb3 Mon Sep 17 00:00:00 2001 From: Slawomir Jaranowski Date: Mon, 11 Dec 2023 11:06:06 +0100 Subject: [PATCH] Document a requirements for plexus compilers (#329) * Document a requirements for plexus compilers * AspectJ and JDK 17+ --- plexus-compiler-api/src/site/site.xml | 18 +++++++++--------- plexus-compiler-manager/src/site/site.xml | 18 +++++++++--------- plexus-compiler-test/src/site/site.xml | 18 +++++++++--------- .../src/site/markdown/index.md | 6 ++++++ .../plexus-compiler-aspectj/src/site/site.xml | 18 +++++++++--------- .../src/site/markdown/index.md | 6 ++++++ .../plexus-compiler-csharp/src/site/site.xml | 18 +++++++++--------- .../src/site/markdown/index.md | 6 ++++++ .../plexus-compiler-eclipse/src/site/site.xml | 18 +++++++++--------- .../src/site/markdown/index.md | 9 +++++++++ .../src/site/site.xml | 17 +++++++++++++++++ .../src/site/markdown/index.md | 6 ++++++ .../plexus-compiler-javac/src/site/site.xml | 18 +++++++++--------- src/site/apt/index.apt | 10 +++++----- src/site/site.xml | 12 ++++++------ 15 files changed, 124 insertions(+), 74 deletions(-) create mode 100644 plexus-compilers/plexus-compiler-aspectj/src/site/markdown/index.md create mode 100644 plexus-compilers/plexus-compiler-csharp/src/site/markdown/index.md create mode 100644 plexus-compilers/plexus-compiler-eclipse/src/site/markdown/index.md create mode 100644 plexus-compilers/plexus-compiler-javac-errorprone/src/site/markdown/index.md create mode 100644 plexus-compilers/plexus-compiler-javac-errorprone/src/site/site.xml create mode 100644 plexus-compilers/plexus-compiler-javac/src/site/markdown/index.md diff --git a/plexus-compiler-api/src/site/site.xml b/plexus-compiler-api/src/site/site.xml index 38cbad8a..656247e9 100644 --- a/plexus-compiler-api/src/site/site.xml +++ b/plexus-compiler-api/src/site/site.xml @@ -1,17 +1,17 @@ - + - - - + + + - - + + - \ No newline at end of file + diff --git a/plexus-compiler-manager/src/site/site.xml b/plexus-compiler-manager/src/site/site.xml index 38cbad8a..656247e9 100644 --- a/plexus-compiler-manager/src/site/site.xml +++ b/plexus-compiler-manager/src/site/site.xml @@ -1,17 +1,17 @@ - + - - - + + + - - + + - \ No newline at end of file + diff --git a/plexus-compiler-test/src/site/site.xml b/plexus-compiler-test/src/site/site.xml index 38cbad8a..656247e9 100644 --- a/plexus-compiler-test/src/site/site.xml +++ b/plexus-compiler-test/src/site/site.xml @@ -1,17 +1,17 @@ - + - - - + + + - - + + - \ No newline at end of file + diff --git a/plexus-compilers/plexus-compiler-aspectj/src/site/markdown/index.md b/plexus-compilers/plexus-compiler-aspectj/src/site/markdown/index.md new file mode 100644 index 00000000..f3e77352 --- /dev/null +++ b/plexus-compilers/plexus-compiler-aspectj/src/site/markdown/index.md @@ -0,0 +1,6 @@ +Plexus AspectJ Compiler +----------------------- + +AspectJ Compiler support for Plexus Compiler component. + +**Requires** `JDK 17+` and `Maven 3.9.6+` \ No newline at end of file diff --git a/plexus-compilers/plexus-compiler-aspectj/src/site/site.xml b/plexus-compilers/plexus-compiler-aspectj/src/site/site.xml index 38cbad8a..656247e9 100644 --- a/plexus-compilers/plexus-compiler-aspectj/src/site/site.xml +++ b/plexus-compilers/plexus-compiler-aspectj/src/site/site.xml @@ -1,17 +1,17 @@ - + - - - + + + - - + + - \ No newline at end of file + diff --git a/plexus-compilers/plexus-compiler-csharp/src/site/markdown/index.md b/plexus-compilers/plexus-compiler-csharp/src/site/markdown/index.md new file mode 100644 index 00000000..c531cbe0 --- /dev/null +++ b/plexus-compilers/plexus-compiler-csharp/src/site/markdown/index.md @@ -0,0 +1,6 @@ +Plexus C# Compiler +------------------ + +C# Compiler support for Plexus Compiler component. + +**Requires** `JDK 8+` \ No newline at end of file diff --git a/plexus-compilers/plexus-compiler-csharp/src/site/site.xml b/plexus-compilers/plexus-compiler-csharp/src/site/site.xml index 38cbad8a..656247e9 100644 --- a/plexus-compilers/plexus-compiler-csharp/src/site/site.xml +++ b/plexus-compilers/plexus-compiler-csharp/src/site/site.xml @@ -1,17 +1,17 @@ - + - - - + + + - - + + - \ No newline at end of file + diff --git a/plexus-compilers/plexus-compiler-eclipse/src/site/markdown/index.md b/plexus-compilers/plexus-compiler-eclipse/src/site/markdown/index.md new file mode 100644 index 00000000..50e4ee1c --- /dev/null +++ b/plexus-compilers/plexus-compiler-eclipse/src/site/markdown/index.md @@ -0,0 +1,6 @@ +Plexus Eclipse Compiler +----------------------- + +Eclipse Compiler support for Plexus Compiler component. + +**Requires** `JDK 17+` and `Maven 3.9.6+` \ No newline at end of file diff --git a/plexus-compilers/plexus-compiler-eclipse/src/site/site.xml b/plexus-compilers/plexus-compiler-eclipse/src/site/site.xml index 38cbad8a..656247e9 100644 --- a/plexus-compilers/plexus-compiler-eclipse/src/site/site.xml +++ b/plexus-compilers/plexus-compiler-eclipse/src/site/site.xml @@ -1,17 +1,17 @@ - + - - - + + + - - + + - \ No newline at end of file + diff --git a/plexus-compilers/plexus-compiler-javac-errorprone/src/site/markdown/index.md b/plexus-compilers/plexus-compiler-javac-errorprone/src/site/markdown/index.md new file mode 100644 index 00000000..620884f1 --- /dev/null +++ b/plexus-compilers/plexus-compiler-javac-errorprone/src/site/markdown/index.md @@ -0,0 +1,9 @@ +Plexus Javac+error-prone Component +---------------------------------- + +Javac Compiler support for Plexus Compiler component, +with error-prone static analysis checks enabled. + +See https://errorprone.info + +**Requires** `JDK 11+` \ No newline at end of file diff --git a/plexus-compilers/plexus-compiler-javac-errorprone/src/site/site.xml b/plexus-compilers/plexus-compiler-javac-errorprone/src/site/site.xml new file mode 100644 index 00000000..dde21855 --- /dev/null +++ b/plexus-compilers/plexus-compiler-javac-errorprone/src/site/site.xml @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + diff --git a/plexus-compilers/plexus-compiler-javac/src/site/markdown/index.md b/plexus-compilers/plexus-compiler-javac/src/site/markdown/index.md new file mode 100644 index 00000000..6d103e3e --- /dev/null +++ b/plexus-compilers/plexus-compiler-javac/src/site/markdown/index.md @@ -0,0 +1,6 @@ +Plexus Javac Component +---------------------- + +Javac Compiler support for Plexus Compiler component. + +**Requires** `JDK 8+` \ No newline at end of file diff --git a/plexus-compilers/plexus-compiler-javac/src/site/site.xml b/plexus-compilers/plexus-compiler-javac/src/site/site.xml index 38cbad8a..656247e9 100644 --- a/plexus-compilers/plexus-compiler-javac/src/site/site.xml +++ b/plexus-compilers/plexus-compiler-javac/src/site/site.xml @@ -1,17 +1,17 @@ - + - - - + + + - - + + - \ No newline at end of file + diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt index d31151aa..76f890b1 100644 --- a/src/site/apt/index.apt +++ b/src/site/apt/index.apt @@ -38,15 +38,15 @@ Plexus Compiler * {{{./plexus-compilers/}<<>>}}: different compilers - * {{{./plexus-compilers/plexus-compiler-aspectj/}<<>>}}: AspectJ compiler, + * {{{./plexus-compilers/plexus-compiler-aspectj/}<<>>}}: AspectJ compiler, <> <<>> and <<>> - * {{{./plexus-compilers/plexus-compiler-csharp/}<<>>}}: C#/Mono compiler, + * {{{./plexus-compilers/plexus-compiler-csharp/}<<>>}}: C#/Mono compiler, <> <<>> - * {{{./plexus-compilers/plexus-compiler-eclipse/}<<>>}}: Eclipse compiler, + * {{{./plexus-compilers/plexus-compiler-eclipse/}<<>>}}: Eclipse compiler, <> <<>> and <<>> - * {{{./plexus-compilers/plexus-compiler-javac/}<<>>}}: javac compiler, + * {{{./plexus-compilers/plexus-compiler-javac/}<<>>}}: javac compiler, <> <<>> - * {{{./plexus-compilers/plexus-compiler-javac-errorprone/}<<>>}}: javac compiler with {{{https://errorprone.info}error-prone}} static analysis checks enabled, + * {{{./plexus-compilers/plexus-compiler-javac-errorprone/}<<>>}}: javac compiler with {{{https://errorprone.info}error-prone}} static analysis checks enabled, <> <<>> [] diff --git a/src/site/site.xml b/src/site/site.xml index acdd1a01..2d94c2f7 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -1,4 +1,4 @@ - + - + - - + +