Code Monkey home page Code Monkey logo

Comments (6)

sjoerdtalsma avatar sjoerdtalsma commented on May 23, 2024

Could you please provide an example of a piece of invalid JavaDoc that triggers this behavior?

from umldoclet.

bertbaron avatar bertbaron commented on May 23, 2024

umldocklet-issue.tar.gz

With the configuration section of the javadoc plugin commented out, the following error appears in the output of mvn clean package:

[ERROR] Exit code: 1 - /home/bert/dev/other/umldocklet-issue/src/main/java/example/JavadocError.java:6: error: invalid use of @return
[ERROR] * @return some field

With the umldoclet enabled however this error is gone.

from umldoclet.

sjoerdtalsma avatar sjoerdtalsma commented on May 23, 2024

The bug that occurred in 0.1.3 has been fixed. That was a NullPointerException that could sometimes happen within the UMLDoclet itself.
So since 0.1.4 the project you uploaded does not seem to throw the meaningless error.
The error without description therefore seems to have been fixed.

However, I find the behavior weird, that the Standard doclet seems to throw the above error, while using the 0.1.5 doclet version accepts your code without any problems.

I think it too should throw the same exception as the Standard doclet throws without the UMLDoclet.
Therefore, I will not close this issue yet, but probably will also not get round to fixing it before the 'First Release' Milestone.

from umldoclet.

sjoerdtalsma avatar sjoerdtalsma commented on May 23, 2024

I still have not found a solution for this issue.
However, there is a workaround by adding option -umlSkipStandardDoclet true to the doclet and afterwards performing another (standard) javadoc run.
In maven you can easily configure this as follows:

<build>
    <plugins>
        <plugin>
            <artifactId>maven-javadoc-plugin</artifactId>
            ...
            <executions>
                <execution>
                    <!-- Call umldoclet to generate UML documentation. -->
                    <id>attach-uml-to-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                    <configuration>
                        <doclet>nl.talsmasoftware.umldoclet.UMLDoclet</doclet>
                        ...
                        <additionalparam>
                            -umlSkipStandardDoclet true
                            ...
                        </additionalparam>
                    </configuration>
                </execution>
                <execution>
                    <!-- Call standard javadoc target for HTML documentation. -->
                    <id>attach-javadocs</id>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

from umldoclet.

sjoerdtalsma avatar sjoerdtalsma commented on May 23, 2024

Needs a re-test to see whether this is still an issue in real projects, using version 1.0.8 1.0.9.

Also, maybe the problem will go away finally with the improved JDK9 Doclet API (see #20).

from umldoclet.

sjoerdtalsma avatar sjoerdtalsma commented on May 23, 2024

This issue seems resolved (at least when testing with jdk 1.8 in our projects) with version 1.0.13.
Please reopen if the issue turns out to persist.

from umldoclet.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.