Skip to content

Commit 23dbed6

Browse files
jknackjknack
committed
build: extract javadoc from open-api
1 parent a542a75 commit 23dbed6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+1418
-2980
lines changed

‎modules/jooby-javadoc/README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Jooby Javadoc (Internal Module)
2+
3+
> ⚠️ **STOP: INTERNAL USAGE ONLY** ⚠️
4+
>
5+
> **This module is strictly for internal use by the Jooby framework. It is NOT intended for public consumption or end-user applications.**
6+
7+
## 🛑 Do Not Build Against This API
8+
9+
Please be aware that the classes and interfaces within this module are considered **private internal implementation details**. We strongly discourage developers from writing code that directly depends on this module.
10+
11+
If you choose to use this module in your own projects, you do so entirely at your own risk. Please note:
12+
13+
* **No Backward Compatibility:** We do not follow semantic versioning for these internal packages.
14+
* **Sudden Breaking Changes:** APIs, method signatures, and entire classes can (and will) be modified, renamed, or completely removed at any time without prior notice or deprecation cycles.
15+
* **No Public Support:** Issues or feature requests related to direct third-party usage of this module will be closed.
16+
17+
## What is this for?
18+
This module contains the abstract syntax tree (AST) extraction logic used internally to parse Javadoc comments. It exists solely to power the official `jooby-openapi` generator.
19+
20+
If your goal is to generate OpenAPI documentation for your application, please depend on the official, public-facing `jooby-openapi` module instead.
21+
22+
---
23+
*If you are a core contributor actively working on Jooby's OpenAPI generation pipeline, you are in the right place.*

‎modules/jooby-javadoc/pom.xml‎

Lines changed: 29 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
2+
<project xmlns="http://maven.apache.org/POM/4.0.0"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
35

46
<modelVersion>4.0.0</modelVersion>
57

@@ -11,29 +13,11 @@
1113
<artifactId>jooby-javadoc</artifactId>
1214
<name>jooby-javadoc</name>
1315

14-
<dependencies>
15-
<dependency>
16-
<groupId>io.jooby</groupId>
17-
<artifactId>jooby</artifactId>
18-
<version>${jooby.version}</version>
19-
</dependency>
20-
21-
<!-- JAXRS -->
22-
<dependency>
23-
<groupId>jakarta.ws.rs</groupId>
24-
<artifactId>jakarta.ws.rs-api</artifactId>
25-
</dependency>
26-
27-
<dependency>
28-
<groupId>jakarta.validation</groupId>
29-
<artifactId>jakarta.validation-api</artifactId>
30-
</dependency>
31-
32-
<dependency>
33-
<groupId>io.swagger.core.v3</groupId>
34-
<artifactId>swagger-models</artifactId>
35-
</dependency>
16+
<!-- <properties>-->
17+
<!-- <Module-Name>io.jooby.javadoc</Module-Name>-->
18+
<!-- </properties>-->
3619

20+
<dependencies>
3721
<dependency>
3822
<groupId>com.puppycrawl.tools</groupId>
3923
<artifactId>checkstyle</artifactId>
@@ -48,16 +32,15 @@
4832
</dependency>
4933

5034
<dependency>
51-
<groupId>org.apache.commons</groupId>
52-
<artifactId>commons-lang3</artifactId>
53-
<version>3.20.0</version>
54-
<scope>test</scope>
35+
<groupId>io.jooby</groupId>
36+
<artifactId>jooby</artifactId>
37+
<version>${jooby.version}</version>
38+
<scope>provided</scope>
5539
</dependency>
5640

5741
<dependency>
58-
<groupId>io.avaje</groupId>
59-
<artifactId>avaje-inject</artifactId>
60-
<version>12.4</version>
42+
<groupId>jakarta.validation</groupId>
43+
<artifactId>jakarta.validation-api</artifactId>
6144
<scope>test</scope>
6245
</dependency>
6346

@@ -75,37 +58,6 @@
7558
<scope>test</scope>
7659
</dependency>
7760

78-
<!-- kotlin -->
79-
<dependency>
80-
<groupId>io.jooby</groupId>
81-
<artifactId>jooby-kotlin</artifactId>
82-
<version>${jooby.version}</version>
83-
<scope>test</scope>
84-
</dependency>
85-
86-
<dependency>
87-
<groupId>org.jetbrains.kotlin</groupId>
88-
<artifactId>kotlin-stdlib</artifactId>
89-
<scope>test</scope>
90-
</dependency>
91-
92-
<dependency>
93-
<groupId>org.jetbrains.kotlin</groupId>
94-
<artifactId>kotlin-reflect</artifactId>
95-
<scope>test</scope>
96-
</dependency>
97-
98-
<dependency>
99-
<groupId>org.jetbrains.kotlinx</groupId>
100-
<artifactId>kotlinx-coroutines-core</artifactId>
101-
<scope>test</scope>
102-
</dependency>
103-
<dependency>
104-
<groupId>net.bytebuddy</groupId>
105-
<artifactId>byte-buddy</artifactId>
106-
<version>1.18.7</version>
107-
<scope>test</scope>
108-
</dependency>
10961
<dependency>
11062
<groupId>org.mockito</groupId>
11163
<artifactId>mockito-core</artifactId>
@@ -119,56 +71,20 @@
11971
</dependency>
12072
</dependencies>
12173

122-
<build>
123-
<plugins>
124-
<plugin>
125-
<groupId>org.jetbrains.kotlin</groupId>
126-
<artifactId>kotlin-maven-plugin</artifactId>
127-
<executions>
128-
<execution>
129-
<id>compile</id>
130-
<phase>none</phase>
131-
</execution>
132-
<execution>
133-
<id>test-compile</id>
134-
<configuration>
135-
<sourceDirs>
136-
<sourceDir>${project.basedir}/src/test/kotlin</sourceDir>
137-
<sourceDir>${project.basedir}/src/test/java</sourceDir>
138-
</sourceDirs>
139-
</configuration>
140-
</execution>
141-
</executions>
142-
</plugin>
143-
144-
<plugin>
145-
<groupId>org.apache.maven.plugins</groupId>
146-
<artifactId>maven-compiler-plugin</artifactId>
147-
<version>${maven-compiler-plugin.version}</version>
148-
<configuration>
149-
<proc>none</proc>
150-
</configuration>
151-
<executions>
152-
<execution>
153-
<id>default-testCompile</id>
154-
<phase>none</phase>
155-
</execution>
156-
<!-- <execution>-->
157-
<!-- <id>java-compile</id>-->
158-
<!-- <goals>-->
159-
<!-- <goal>compile</goal>-->
160-
<!-- </goals>-->
161-
<!-- <phase>compile</phase>-->
162-
<!-- </execution>-->
163-
<execution>
164-
<id>java-test-compile</id>
165-
<goals>
166-
<goal>testCompile</goal>
167-
</goals>
168-
<phase>test-compile</phase>
169-
</execution>
170-
</executions>
171-
</plugin>
172-
</plugins>
173-
</build>
74+
<!-- <build>-->
75+
<!-- <plugins>-->
76+
<!-- <plugin>-->
77+
<!-- <groupId>org.apache.maven.plugins</groupId>-->
78+
<!-- <artifactId>maven-jar-plugin</artifactId>-->
79+
<!-- <version>${maven-jar-plugin.version}</version>-->
80+
<!-- <configuration>-->
81+
<!-- <archive>-->
82+
<!-- <manifestEntries>-->
83+
<!-- <Automatic-Module-Name>${Module-Name}</Automatic-Module-Name>-->
84+
<!-- </manifestEntries>-->
85+
<!-- </archive>-->
86+
<!-- </configuration>-->
87+
<!-- </plugin>-->
88+
<!-- </plugins>-->
89+
<!-- </build>-->
17490
</project>

0 commit comments

Comments
 (0)