Skip to content

Commit

Permalink
Add Module.md files for different artifacts with module and package i…
Browse files Browse the repository at this point in the history
…nfo (#4844)

* Add Module.md files for different artifacts with module and package info

This is what dokka uses to document packages and modules. Deleted the `package-info.kt` file as it doesn't do anything on its own, but can restore if it's still wanted

* Add Module.md for mockwebserver

* Only specify module if it exists

A bunch of samples don't have modules or readmes

* Remove package descriptors
  • Loading branch information
ZacSweers authored and swankjesse committed Apr 2, 2019
1 parent e8c5d77 commit b042f1e
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 2 deletions.
3 changes: 3 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,9 @@ subprojects { project ->
prefix = "okhttp3.internal"
suppress = true
}
if (project.file('Module.md').exists()) {
includes = ['Module.md']
}
externalDocumentationLink {
url = new URL("https://square.github.io/okio/2.x/okio/jvm/index.html")
packageListUrl = new URL("https://square.github.io/okio/2.x/okio/jvm/package-list")
Expand Down
3 changes: 3 additions & 0 deletions mockwebserver/Module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Module mockwebserver

A scriptable web server for testing HTTP clients.
3 changes: 3 additions & 0 deletions okhttp-logging-interceptor/Module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Module okhttp-logging-interceptor

An OkHttp interceptor which logs HTTP request and response data.

This file was deleted.

3 changes: 3 additions & 0 deletions okhttp-sse/Module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Module okhttp-sse

Support for server-sent events.
3 changes: 3 additions & 0 deletions okhttp-tls/Module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Module okhttp-tls

OkHttp Transport Layer Security (TLS) library.
3 changes: 3 additions & 0 deletions okhttp/Module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Module okhttp

An HTTP+HTTP/2 client for Android and Java applications.

0 comments on commit b042f1e

Please sign in to comment.