Wrong class in documentation generation
See original GitHub issueHello,
I might be missing something, but in one of API endpoints, I implemented a PATCH operation, which takes a DocumentType
as parameter. This is however one of our custom models, and not the DocumentType defined in several namespaces.
The import
statements etc are all correct, as is the annotations.
When running the maven build, my documentation get’s generated, however the output contains the wrong DocumentType
class. It’s as if the plugin seems to take the first matching class, and not the one I specified.
Issue Analytics
- State:
- Created 5 years ago
- Comments:17 (6 by maintainers)
Top Results From Across the Web
Android - failed to generate Javadoc with Android Studio ...
I just spent 5 days on this error and found a solution that works (for me. ... Normally documentation generation failed with "exit...
Read more >Documenting Your Classes and Methods - Courses
This tool can automatically extract documentation comments from source code and generate HTML class descriptions, like those in the cs1705 Package API.
Read more >How to Write Doc Comments for the Javadoc Tool - Oracle
This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, ...
Read more >Javadocs | IntelliJ IDEA Documentation - JetBrains
Add Javadoc comments, generate your own Javadoc reference, and view downloaded Javadocs right from the IntelliJ IDEA editor.
Read more >Common issues and solutions - mypy 0.991 documentation
There are several common reasons why obviously wrong code is not flagged as an error. ... considered as untyped method foo(1) # No...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
not getting much difference unfortunately.
So it simply exposes hidden APIs when it’s used, otherwise relies on the standard implementation. Swagger still seems to be using some kind of different class for the example unfortunately:
I have no idea to what this is being mapped, but it doesn’t resemble a single class we have in use for our code.
Tried setting the
springmvc
configuration to false, did not seem to have any direct result/difference on the generated documentation.Here’s a link to the gist for the fully generated swagger file: https://gist.github.com/coding-bunny/56a586d425846faaea74817dca398fe5