https://kotlinlang.org logo
Channels
Powered by
#dokka
  • s

    sindrenm

    04/27/2018, 8:05 AM
    Right, I think I read that as well, that it doesn't have a concept over overloaded methods. I guess it makes sense that the same applies for constructors. Thanks. simple smile
  • z

    Zac Sweers

    04/28/2018, 10:26 PM
    feels awkward to have to ask this, but is Dokka maintained?
  • a

    andries.fc

    05/03/2018, 2:09 PM
    @andries.fc pinned a message to this channel.
  • a

    andrei.heidelbacher

    05/05/2018, 12:54 PM
    It's been a year since I reported and Dokka still can't link to standard Java types (e.g., String) in Javadoc format output, even with the latest 0.9.16 release.
  • r

    robfletcher

    05/07/2018, 4:25 PM
    When I wrote a book for O’Reilly it was great having the security of all the code samples being tested because they were just includes in Asciidoc files and the whole book “built” with Gradle. I guess I’m addicted to that kind of process now.
  • e

    egorand

    05/12/2018, 1:54 AM
    I was doing some crossplatform stuff recently, and I'd really like to store my KDoc in expect classes - looks like Dokka doesn't handle this well at the moment
  • e

    egorand

    05/12/2018, 1:54 AM
    currently I'd have to copy it into the platform class to see it in the docs
  • s

    semoro

    05/21/2018, 1:30 PM
  • l

    louiscad

    06/27/2018, 5:33 PM
    Is anyone aware of any open source Android library project that uses Dokka, linked against Android SDK references, working for javadoc online reference (not androidX kotlin reference yet)?
  • s

    snowe

    07/01/2018, 3:34 PM
    I'm having trouble generating documentation for properties. With this code
  • s

    snowe

    07/01/2018, 3:34 PM
    Copy code
    /**
     * Used for retrieving the instance of the TestExecutor for usage outside the bounds of the DSL
     *
     * @sample com.tylerthrailkill.axon_kotlin.samples.SamplesTest.showRetrievingTestExecutor
     */
    lateinit var testExecutor: TestExecutor
    /**
     * Used for retrieving the instance of the ResultValidator for usage outside the bounds of the DSL
     *
     * @sample com.tylerthrailkill.axon_kotlin.samples.SamplesTest.showRetrievingTestExecutor
     */
    private var _resultValidator: ResultValidator? = null
  • s

    snowe

    07/01/2018, 3:34 PM
    it generates this documentation
  • s

    snowe

    07/01/2018, 3:34 PM

    https://i.imgur.com/G7c8I40.png▾

  • s

    snowe

    07/01/2018, 3:34 PM
    notice that the samples are not included.
  • s

    snowe

    07/01/2018, 3:35 PM
    buuuttttt.
  • s

    snowe

    07/01/2018, 3:35 PM
    if I remove the lines explaining the property and just leave the sample.
  • s

    snowe

    07/01/2018, 3:35 PM
    Copy code
    /**
     * @sample com.tylerthrailkill.axon_kotlin.samples.SamplesTest.showRetrievingTestExecutor
     */
    lateinit var testExecutor: TestExecutor
    /**
     * @sample com.tylerthrailkill.axon_kotlin.samples.SamplesTest.showRetrievingTestExecutor
     */
    private var _resultValidator: ResultValidator? = null

    https://i.imgur.com/ktCznby.png▾

  • s

    snowe

    07/01/2018, 3:36 PM
    it generates one sample???
  • s

    snowe

    07/01/2018, 3:36 PM
    I really don't understand how that is happening.
  • s

    snowe

    07/01/2018, 3:41 PM
    ah ignore the part about 1 sample. didn't realize I was doing it on the private variable. I still have the problem that if I give any documentation, the sample doesn't generate
  • s

    snowe

    07/02/2018, 1:36 AM
    why is dokka generating the documentation like this?

    https://i.imgur.com/hLI6vpk.png▾

  • s

    snowe

    07/02/2018, 1:36 AM
    with index.html inside of the module folder instead of next to style.css?
  • s

    snowe

    07/02/2018, 1:37 AM
    It's very hard to publish a site with this generation strategy. Is there any way to change how dokka generates the html? I would like to publish my documentation using github pages, but currently cannot due to the placement of this stylesheet.
  • r

    robstoll

    07/02/2018, 10:02 AM
    what about moving style.css as part of your deployment? (that's what I do)
  • s

    snowe

    07/02/2018, 3:08 PM
    @robstoll I can do that, but then I have to rewrite every reference to it in every file that uses it, do I not?
  • r

    robstoll

    07/02/2018, 3:19 PM
    Depending on your url since it is a relative path ../ if your docs are hosted at docs.example.com then no since ../style.css still refers to docs.example.com/style.css
  • r

    robstoll

    07/02/2018, 3:20 PM
    But anyway it is only a work around. Still good if one could specify the path somehow
  • f

    freddiewang

    07/12/2018, 8:27 AM
    I had the same css issue so I generated the mardown files..
  • n

    nhaarman

    08/30/2018, 8:53 AM
    How do you document lambda parameters that have parameters themselves? e.g.
    Copy code
    /**
 * @param f the action to run.
 */
fun foo(f: (String) -> Unit
    I want to document what 
    String
    here is.
  • i

    Ian

    08/30/2018, 1:43 PM
    Anyone have any idea what’s going on here?
    Copy code
    FAILURE: Build failed with an exception.
* What went wrong:
Could not determine the dependencies of task ':dokkaJavadoc'.
> Could not resolve all files for configuration ':kotlinCompilerClasspath'.
   > Could not resolve org.jetbrains.kotlin:kotlin-compiler-embeddable:1.2.61.
     Required by:
         project :
      > Could not resolve org.jetbrains.kotlin:kotlin-compiler-embeddable:1.2.61.
         > Could not get resource '<https://repo.maven.apache.org/maven2/org/jetbrains/kotlin/kotlin-compiler-embeddable/1.2.61/kotlin-compiler-embeddable-1.2.61.pom>'.
            > Could not HEAD '<https://repo.maven.apache.org/maven2/org/jetbrains/kotlin/kotlin-compiler-embeddable/1.2.61/kotlin-compiler-embeddable-1.2.61.pom>'. Received status code 403 from server: Forbidden
1...515253...58Latest