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

Outline API Reference #209

Closed
bamboo opened this Issue Jan 5, 2017 · 3 comments

Comments

Projects
None yet
2 participants
@bamboo
Member

bamboo commented Jan 5, 2017

Generate Gradle Script Kotlin API docs using Dokka.

Similar to the Gradle javadoc but including gradle-script-kotlin API extensions.

The API should be shown with Kotlin syntax (even the Gradle API).

@bamboo bamboo modified the milestones: 1.0.0, 0.8.0 Jan 5, 2017

@bamboo bamboo modified the milestones: 0.9.0, 0.8.0 Feb 14, 2017

@bamboo bamboo changed the title from Kotlin API Documentation Outline to User Manual Outline Feb 23, 2017

@bamboo bamboo changed the title from User Manual Outline to Outline User Manual Feb 23, 2017

@bamboo bamboo changed the title from Outline User Manual to Outline API Reference Feb 23, 2017

@eskatos eskatos self-assigned this Apr 18, 2017

@eskatos

This comment has been minimized.

Show comment
Hide comment
@eskatos

eskatos Apr 19, 2017

Member

A first cut of an API doc generated using Dokka is now available: https://gradle.github.io/gradle-script-kotlin-docs/api/

The corresponding build can be found here: https://github.com/gradle/gradle-script-kotlin-docs

The Gradle API definition has been copied from the Gradle build, we should find a way to share that explicitly instead.

Member

eskatos commented Apr 19, 2017

A first cut of an API doc generated using Dokka is now available: https://gradle.github.io/gradle-script-kotlin-docs/api/

The corresponding build can be found here: https://github.com/gradle/gradle-script-kotlin-docs

The Gradle API definition has been copied from the Gradle build, we should find a way to share that explicitly instead.

@eskatos

This comment has been minimized.

Show comment
Hide comment
@eskatos

eskatos Apr 29, 2017

Member

I did look into all the dokka warnings and the <ERROR CLASS> in the html output.
They come from usage of Gradle internal APIs which we don't provide to dokka.
e.g. https://gradle.github.io/gradle-script-kotlin-docs/api/org.gradle.script.lang.kotlin.cache/-script-cache/index.html
We need to filter GSK internals out.

Member

eskatos commented Apr 29, 2017

I did look into all the dokka warnings and the <ERROR CLASS> in the html output.
They come from usage of Gradle internal APIs which we don't provide to dokka.
e.g. https://gradle.github.io/gradle-script-kotlin-docs/api/org.gradle.script.lang.kotlin.cache/-script-cache/index.html
We need to filter GSK internals out.

eskatos added a commit that referenced this issue May 2, 2017

Tighten exported API
This commit adds `internal` or `private` to internal members
The only exported API that includes Gradle internals is now in .provider

See #209
@eskatos

This comment has been minimized.

Show comment
Hide comment
@eskatos

eskatos May 2, 2017

Member

Once #348 is in, the API docs contain:

The only remaining <ERROR CLASS> are on two extensions of Gradle internal types that the built-in plugins exposes:

Member

eskatos commented May 2, 2017

Once #348 is in, the API docs contain:

The only remaining <ERROR CLASS> are on two extensions of Gradle internal types that the built-in plugins exposes:

eskatos added a commit that referenced this issue May 2, 2017

Tighten exported API
This commit adds `internal` or `private` to internal members
The only exported API that includes Gradle internals is now in .provider

See #209

eskatos added a commit that referenced this issue May 2, 2017

Tighten exported API
This commit adds `internal` or `private` to internal members
The only exported API that includes Gradle internals is now in .provider

See #209

@bamboo bamboo closed this May 6, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment