Skip to content
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

Description List not handled in docs #2213

Closed
asfalcone opened this issue Oct 28, 2021 · 2 comments · Fixed by #2259
Closed

Description List not handled in docs #2213

asfalcone opened this issue Oct 28, 2021 · 2 comments · Fixed by #2259
Assignees
Labels
bug feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs

Comments

@asfalcone
Copy link
Contributor

Describe the bug
Description List (<dl>, <dt>, <dd>) isn't parsed properly.

In java, the description items are removed. In Kotlin they appear as body text instead of structured DocTag elements

Expected behaviour
Dl, Dt, DD appear as structured DocTag elements

Screenshots
From Kotlin source:
image

From Java source:
image

To Reproduce

/** 
 * <dl>
 *     <dt>
 *         <code>name="<i>name</i>"</code>
 *     </dt>
 *     <dd>
 *         A URI path segment. To enforce security, this value hides the name of the subdirectory
 *         you're sharing. The subdirectory name for this value is contained in the
 *         <code>path</code> attribute.
 *     </dd>
 *     <dt>
 *         <code>path="<i>path</i>"</code>
 *     </dt>
 *     <dd>
 *         The subdirectory you're sharing. While the <code>name</code> attribute is a URI path
 *         segment, the <code>path</code> value is an actual subdirectory name. Notice that the
 *         value refers to a <b>subdirectory</b>, not an individual file or files. You can't
 *         share a single file by its file name, nor can you specify a subset of files using
 *         wildcards.
 *     </dd>
 * </dl>
 */
 * class Foo

Installation

  • Dokka version: 1.6.0-dev-122
@asfalcone asfalcone added the bug label Oct 28, 2021
@vmishenev vmishenev added the feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs label Oct 28, 2021
@IgnatBeresnev IgnatBeresnev self-assigned this Nov 25, 2021
@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Dec 2, 2021

@asfalcone Hi! I can't tell from the Foo class whether it's a kotlin or a java class :) What's the use case? Would you like to be able to make description lists in JavaDocs only or in KDocs as well?

It's definitely a bug in the javadoc parser (working on a fix), but it's unclear to me at the moment whether we should support parsing html tags in KDoc at all. Is it possible to make some sort of a description list using markdown?

@IgnatBeresnev
Copy link
Member

Will be included in the upcoming 1.6.10. The dev version is out.

owengray-google pushed a commit to owengray-google/dokka that referenced this issue Dec 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants