Giter Club home page Giter Club logo

Comments (12)

rmpestano avatar rmpestano commented on September 12, 2024 1

Yes, install this project locally (mvn install)

then install https://github.com/sdaschner/jaxrs-analyzer-maven-plugin and then upgrade your project to use the installed maven plugin and finally run mvnDebug clean package on your project, you'll need to remote debug on port 8000.

If find any problems trying to debug just ask for help here.

the error is here, if you put a breakpoint here you may find the endpoint which has the invalid javadoc tag.

from jaxrs-analyzer.

rmpestano avatar rmpestano commented on September 12, 2024

Hi @dizzzz,

Could you isolate the issue? do you have an example endpoint which reproduces it?

from jaxrs-analyzer.

dizzzz avatar dizzzz commented on September 12, 2024

I will try! One question I have (to understand the design a bit better): what is the purpose of reading javadoc details? I guess somewhere some rotten javadoc code is written, how robust is this part of the code? If it is left out... what is missing?

from jaxrs-analyzer.

dizzzz avatar dizzzz commented on September 12, 2024

Is there a way to see on which .java file an issue occurs?

from jaxrs-analyzer.

rmpestano avatar rmpestano commented on September 12, 2024

It is on the stacktrace (JavaDocParserVisitor.java:141)

from jaxrs-analyzer.

dizzzz avatar dizzzz commented on September 12, 2024

@rmpestano :-) I meant the file that is being parsed by the tool. My question is related to my earlier question. I think we have some missing / wrong / inconsistent javadoc syntax, but can't yet figure out which one.

from jaxrs-analyzer.

rmpestano avatar rmpestano commented on September 12, 2024

Ohh my bad, I don't think so, If you can zip your project I can try to find out by debuging (probably something related to the javadoc as the error is on the javadoc parser)

from jaxrs-analyzer.

dizzzz avatar dizzzz commented on September 12, 2024

@rmpestano unfortunately I cannot send the code (completely), an 'anonymized' part would be feasible but for this I need to know which file I need to check.

from jaxrs-analyzer.

dizzzz avatar dizzzz commented on September 12, 2024

maybe the debugger can help here?

from jaxrs-analyzer.

dizzzz avatar dizzzz commented on September 12, 2024

@rmpestano My question remains: how is the contents of the javadoc used in the end result?

from jaxrs-analyzer.

rmpestano avatar rmpestano commented on September 12, 2024

it is used to enhance the generated swagger.json, e.g add description to endpoint params, return types and so on, see an example here.

from jaxrs-analyzer.

dizzzz avatar dizzzz commented on September 12, 2024

I guess I need something as

image

but I am not yet sure what will happen 'downstream'....

from jaxrs-analyzer.

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.