Comments (18)
I'd need to see the source file which causes the problem
from dokka.
@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 @suppress
comment added:
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 null:-1:-1: Tag @see
messages.
If I come up with additional cases, I will let you know. Hope that helps!
from dokka.
Thanks for your investigation, it definitely does help! I'll look into these issues soon.
from dokka.
@yole This is still happening in 0.9.10. Wondering if it will be worked on soon. Thanks.
from dokka.
@semoro @yole Thanks for working on this one!
from dokka.
I still get spammed to death by null:-1:-1: Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method
even though I have no @see tag ANYWHERE. And the error message isn't any help either...
from dokka.
Same to me (using version 0.9.17). You can check my project: https://github.com/mstachniuk/graphql-schema-from-introspection-generator
./gradlew clean build
> Task :graphql-schema-from-introspection-generator-core:dokka
null:-1:-1: Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
from dokka.
Problem with @see
tags still reproduces, and should be fixed
from dokka.
Same to me (using version 0.9.17). You can check my project: https://github.com/Vorlonsoft/AndroidRate
from dokka.
Guys, this is super annoying! My build log contains over 20 lines of this useless message:
null:-1:-1: Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
it isn't an actionable error, so please just remove it until is serves a purpose...
from dokka.
Any word on this? Since I tend to use @suppress
on overridden hashCode/equals methods my build log if full of the null errors ... is it just a simple mixup confusing @suppress
with @see
???
from dokka.
So its not just the @suppress
.
It is also caused by the documentation links A [FooBar] implementation.
... this gets resolved as a @see
.
Removing the link references for a class/method eliminates the error.
from dokka.
Still relevant for me, I have no @see in my docs at all
Using dokka maven plugin, 0.9.18
from dokka.
Seeing the same problem, happens when an interface B implements an interface A, with A having an annotation.
from dokka.
Can we remove this logs from the console output?
from dokka.
This will be fixed in 0.11.0 hopefully
from dokka.
Running into this as well. Happens when you reference classes/functions using brackets, e.g.
/**
* See [foo] and [bar]
*/
Output spams:
null:-1:-1: Tag @see cannot be used in inline documentation. It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.
from dokka.
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.
from dokka.
Related Issues (20)
- Prepare for the release of Dokka 2.0.0
- [K2] Spike: research the behaviour of Kotlin/Java interop around getters/setters and inheritance HOT 1
- Set up playwright to run UI screenshot tests
- [K1] Resolved references to synthetic java properties
- Missed KDoc link if a comment starts with it
- [K2] Inconsistent documentable rendering order
- Make `DokkaBaseConfiguration.customAssets` lazy HOT 1
- The Dokka versioning dropdown is not visible HOT 2
- [email protected] HOT 5
- Any plan to support inline tag {@link} and block tag {@link} for kotlin comment? HOT 2
- Mentions of API excluded from the docs should not be links
- [K2] Inconsistent reference from constructor kdoc to class page for K1/K2 HOT 1
- Gradle Dokka build intermittently hangs HOT 1
- Restyle "Since @version" block, now it draws too much attention
- Disable code highlighting for inline codeblock
- Do not add dependent source sets for @sample source roots
- Do not show `open` for Java fields
- Source link rendered twice if name of property and function clashed
- Theme switcher blink on link jumps in Safari
- Theme switcher doesn't work on the root page of multimodule project HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from dokka.