play-omnidoc


License

License

GroupId

GroupId

com.typesafe.play
ArtifactId

ArtifactId

play-omnidoc_2.11
Last Version

Last Version

2.7.9
Release Date

Release Date

Type

Type

jar
Description

Description

play-omnidoc
play-omnidoc
Project URL

Project URL

https://github.com/playframework/omnidoc
Project Organization

Project Organization

com.typesafe.play
Source Code Management

Source Code Management

https://github.com/playframework/omnidoc

Download play-omnidoc_2.11

How to add to project

<!-- https://jarcasting.com/artifacts/com.typesafe.play/play-omnidoc_2.11/ -->
<dependency>
    <groupId>com.typesafe.play</groupId>
    <artifactId>play-omnidoc_2.11</artifactId>
    <version>2.7.9</version>
</dependency>
// https://jarcasting.com/artifacts/com.typesafe.play/play-omnidoc_2.11/
implementation 'com.typesafe.play:play-omnidoc_2.11:2.7.9'
// https://jarcasting.com/artifacts/com.typesafe.play/play-omnidoc_2.11/
implementation ("com.typesafe.play:play-omnidoc_2.11:2.7.9")
'com.typesafe.play:play-omnidoc_2.11:jar:2.7.9'
<dependency org="com.typesafe.play" name="play-omnidoc_2.11" rev="2.7.9">
  <artifact name="play-omnidoc_2.11" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.typesafe.play', module='play-omnidoc_2.11', version='2.7.9')
)
libraryDependencies += "com.typesafe.play" % "play-omnidoc_2.11" % "2.7.9"
[com.typesafe.play/play-omnidoc_2.11 "2.7.9"]

Dependencies

compile (2)

Group / Artifact Type Version
org.scala-lang : scala-library jar 2.11.12
com.typesafe.play : play-docs_2.11 jar 2.7.9

Project Modules

There are no modules declared in this project.

Omnidoc

Omnidoc is an sbt build that adds to sbt's mappings in (Compile, packageBin) to aggregate source code and manuals produced within the Play ecosystem and produce a single deliverable. This must not be confused with Interplay's Omnidoc which simply adds some metadata on the -source.jar artifact of every Play library.

The resulting deliverable includes:

  • manual (also referred to as playdoc)
  • javadoc
  • scaladoc

How it works

Omnidoc defines 5 tasks to:

  1. download -sources.jar and -playdoc.jar artifacts for each dependency
  2. extract the dowloaded -sourcesartifacts into omnidoc/sources/
  3. extract the dowloaded -playdocartifacts into omnidoc/playdoc/
  4. use omnidoc/sources/ to produce omnidoc/javadoc/
  5. use omnidoc/sources/ to produce omnidoc/scaladoc/
  6. package playdoc into play/docs/content
  7. package javadoc into play/docs/content/api/java
  8. package scaladoc into play/docs/content/api/scala

NOTE: all the paths above are relative to target/scala-2.1x/ (for example target/scala-2.12/).

com.typesafe.play

Play Framework

Versions

Version
2.7.9
2.7.8
2.7.7
2.7.6
2.7.5
2.7.4
2.7.3
2.7.2
2.7.1
2.7.0
2.7.0-RC9
2.7.0-RC8
2.7.0-RC3
2.7.0-M4
2.7.0-M3
2.7.0-M2
2.7.0-M1
2.6.25
2.6.24
2.6.23
2.6.22
2.6.21
2.6.20
2.6.19
2.6.18
2.6.17
2.6.16
2.6.15
2.6.14
2.6.13
2.6.12
2.6.11
2.6.10
2.6.9
2.6.7
2.6.6
2.6.5
2.6.3
2.6.2
2.6.1
2.6.0
2.6.0-RC2
2.6.0-RC1
2.6.0-M5
2.6.0-M4
2.6.0-M3
2.6.0-M2
2.6.0-M1
2.5.19
2.5.18
2.5.17
2.5.16
2.5.15
2.5.14
2.5.13
2.5.12
2.5.11
2.5.10
2.5.9
2.5.8
2.5.7
2.5.6
2.5.5
2.5.4
2.5.3
2.5.2
2.5.1
2.5.0
2.5.0-RC2
2.5.0-RC1
2.5.0-M2
2.5.0-M1
2.4.11
2.4.10
2.4.9
2.4.8
2.4.7
2.4.6
2.4.4
2.4.3
2.4.2
2.4.1
2.4.0
2.4.0-RC5
2.4.0-RC3
2.4.0-RC2
2.4.0-RC1
2.4.0-M3
2.4.0-M2