-
Notifications
You must be signed in to change notification settings - Fork 399
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Javadoc generation fails via dokka-gradle-plugin (v0.9.9) #90
Comments
I'd need to see the source file which causes the problem |
@yole, after further investigation, these are actually two separate error conditions. One is fatal to the javadoc generation, the other isn't. The stack overflow error is caused if I apply an annotation to an interface: package demo
/**
* This class supports greeting people by name.
*
* @property name The name of the person to be greeted.
*/
class GreeterImpl(val name: String): Greeter {
/**
* Prints the greeting to the standard output.
*/
override fun greet() {
println("Hello $name!")
}
}
/**
* Implementers will greet people.
*/
@Beta
interface Greeter {
fun greet()
}
fun main(args: Array<String>) {
demo.GreeterImpl(args[0]).greet()
}
@Retention(AnnotationRetention.BINARY)
@Target(AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FIELD, AnnotationTarget.FUNCTION,
AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.CLASS, AnnotationTarget.FILE)
@MustBeDocumented
annotation class Beta In this case, the documentation halts. Applying an annotation to the interface methods does not cause issues. (The stack overflow does not occur when the output format is "HTML," only "javadoc") The "null tag" error occurs if a referenced class has the package demo
/**
* This class supports greeting people by name.
* Inherits from [Greeter] which has a `suppress` doc comment
*
* @property name The name of the person to be greeted.
*/
class GreeterImpl(val name: String): Greeter {
/**
* Prints the greeting to the standard output.
*/
override fun greet() {
println("Hello $name!")
}
}
/**
* @suppress
*/
interface Greeter {
fun greet()
}
fun main(args: Array<String>) {
demo.GreeterImpl(args[0]).greet()
} In this case, the documentation completes despite the If I come up with additional cases, I will let you know. Hope that helps! |
Thanks for your investigation, it definitely does help! I'll look into these issues soon. |
@yole This is still happening in 0.9.10. Wondering if it will be worked on soon. Thanks. |
I still get spammed to death by |
Same to me (using version 0.9.17). You can check my project: https://github.com/mstachniuk/graphql-schema-from-introspection-generator
|
Problem with |
Same to me (using version 0.9.17). You can check my project: https://github.com/Vorlonsoft/AndroidRate |
Guys, this is super annoying! My build log contains over 20 lines of this useless message: |
Any word on this? Since I tend to use |
So its not just the It is also caused by the documentation links Removing the link references for a class/method eliminates the error. |
Still relevant for me, I have no @see in my docs at all |
* Updated the published artifacts names and removed unused publication section * Updated the README with the download section * Added the real support for js and native platforms * Project changes - Added the real support for js and native platforms - Removed the Hex object to avoid unnecessary overhead - Renamed the `khex` module into `core` - Renamed the `khex-extensions` module into `extensions` - Changed the project group to `org.komputing.khex` * Changed the project version to 0.0.1 * Changes - Added Gradle Wrapper - Updated the project group id to reflect the one that Jitpack choses * Changed version to 1.0.0-RC2 to maintain linearity of versions * Removed the links of variables due to Dokka build errors (see Kotlin/dokka#90)
Seeing the same problem, happens when an interface B implements an interface A, with A having an annotation. |
Can we remove this logs from the console output? |
This will be fixed in 0.11.0 hopefully |
Running into this as well. Happens when you reference classes/functions using brackets, e.g.
Output spams: |
As far as I know, it is fixed in 1.4.0. If the problem is persisting it is ok to open a new issue as it will definitely have a different root cause that this problem. |
…otlin/dokka#90)" This reverts commit 703da59.
* Add dokka again * Revert "Removed the links of variables due to Dokka build errors (see Kotlin/dokka#90)" This reverts commit 703da59.
Given the closure ...
... Receiving the following output when running
./gradlew dokka
:@see
tags definedindex.html
is never createdoutputFormat
is not specified, default html files are created correctlyLet me know if you need any more information. Thanks!
The text was updated successfully, but these errors were encountered: