You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There are cases where the JavaDoc (KDoc) documentation of a method/field (or in Kotlin property) is useful at runtime (think e.g. describing a configuration class, which is used both by the developer and the enduser). If a custom annotation is used for this purpose it must be kept in sync with the normal documentation. I propose adding a @Doc or @Documentation or similar in which this documentation can be written. IDEs can then display this as-if it was written as real JavaDoc/KDoc.
The text was updated successfully, but these errors were encountered:
I think this goes outside the scope of java-annotations project. It looks like the use-case is pretty limited, and this would enforce a completely new form of documentation, incompatible with any known tools, including javadoc, or any Java IDEs. Instead, if you really need this in your project, you can write a source file processor which will dump the documentation from normal Javadoc into a format you like. E.g., you can generate a JSON file in the resources, which contains all the documentation, and load it at runtime. You may probably even reuse the existing javadoc tool providing a custom doclet.
There are cases where the JavaDoc (KDoc) documentation of a method/field (or in Kotlin property) is useful at runtime (think e.g. describing a configuration class, which is used both by the developer and the enduser). If a custom annotation is used for this purpose it must be kept in sync with the normal documentation. I propose adding a
@Doc
or@Documentation
or similar in which this documentation can be written. IDEs can then display this as-if it was written as real JavaDoc/KDoc.The text was updated successfully, but these errors were encountered: