Skip to content
This repository has been archived by the owner on Jun 9, 2024. It is now read-only.

Delombok code before building javadocs #300

Closed
queer opened this issue Apr 3, 2019 · 4 comments
Closed

Delombok code before building javadocs #300

queer opened this issue Apr 3, 2019 · 4 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@queer
Copy link
Member

queer commented Apr 3, 2019

In THEORY this should deal with the kinds of build failures we see in ex #277.

@queer queer added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Apr 3, 2019
@luaugg
Copy link
Contributor

luaugg commented Apr 3, 2019

Stop stealing all the good numbers :(

@queer
Copy link
Member Author

queer commented Apr 3, 2019

git gud

@broman
Copy link

broman commented Apr 3, 2019

HA i get it
git gud

@queer queer mentioned this issue Apr 3, 2019
14 tasks
@queer queer changed the title Mark lombok stuff with @exclude javadocs Delombok code before building javadocs Apr 8, 2019
@queer
Copy link
Member Author

queer commented Apr 8, 2019

More accurate title 😅 Really the problem is just that some lombok members don't exist per se, so it makes sense that javadoc wouldn't be aware of them. Delomboking before generating docs should solve this. It might be acceptable to just do something like (Source)

<plugin>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok-maven-plugin</artifactId>
    <version>1.18.0.0</version>
    <configuration>
        <sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
        <outputDirectory>${delombok.output}</outputDirectory>
        <addOutputDirectory>false</addOutputDirectory>
    </configuration>
    <executions>
        <execution>
            <phase>generate-sources</phase>
            <goals>
                <goal>delombok</goal>
            </goals>
        </execution>
    </executions>
</plugin>
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <configuration>
        <sourcepath>${delombok.output}</sourcepath>
    </configuration>
</plugin>

@queer queer closed this as completed in #304 Apr 8, 2019
mirabilos added a commit to qvest-digital/rfc822 that referenced this issue Jan 13, 2021
delombok output is NOT used for compilation but as javadoc input;
fixes: projectlombok/lombok#2502

from mewna/catnip#300 😼
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants