diff options
| author | Vlad Ureche <vlad.ureche@gmail.com> | 2012-06-16 18:47:40 +0200 |
|---|---|---|
| committer | Vlad Ureche <vlad.ureche@gmail.com> | 2012-07-02 13:34:15 +0200 |
| commit | 44ec110bf059a089f54c06469ff2a54275d0f05f (patch) | |
| tree | 61d4c0d455ca3001262d887f059274d3439373f2 /build.xml | |
| parent | b0d70beb50e9d7946166f0218cf42bc1d9850754 (diff) | |
| download | scala-44ec110bf059a089f54c06469ff2a54275d0f05f.tar.gz scala-44ec110bf059a089f54c06469ff2a54275d0f05f.tar.bz2 scala-44ec110bf059a089f54c06469ff2a54275d0f05f.zip | |
Scaladoc diff-firendly output
Scaladoc can create raw content files that we can easily diff and spot
any modifications. There is a cool project by Stefan Zeiger to export
the scaladoc model in JSON, but with the language and scaladoc being so
quick to evolve, it'll be a pain to properly maintain. In the long-run,
the plan is to sample a couple of raw files on each build and email me
the diff. If I spot anything that may be wrong I can fix it, revert the
commit or at least file a bug.
For now, .html.raw files are generated on-demand, using
ant -Dscaladoc.raw.output="yes" <targets>
Also added a script that will do the job of diff-ing.
Review by @jsuereth.
Conflicts:
src/compiler/scala/tools/nsc/doc/Settings.scala
Diffstat (limited to 'build.xml')
| -rw-r--r-- | build.xml | 17 |
1 files changed, 10 insertions, 7 deletions
@@ -2064,6 +2064,9 @@ DOCUMENTATION <!-- Compute the URL and show it --> <property name="scaladoc.url" value="https://github.com/scala/scala/tree/${scaladoc.git.commit}/src"/> <echo message="Scaladoc will point to ${scaladoc.url} for source files."/> + + <!-- Unless set with -Dscaladoc.raw.output, it won't be activated --> + <property name="scaladoc.raw.output" value="no"/> </target> <target name="docs.pre-lib" depends="docs.start"> @@ -2091,7 +2094,7 @@ DOCUMENTATION classpathref="pack.classpath" addparams="${scalac.args.all}" docRootContent="${src.dir}/library/rootdoc.txt" - implicits="on" diagrams="on"> + implicits="on" diagrams="on" rawOutput="${scaladoc.raw.output}"> <src> <files includes="${src.dir}/actors-migration"/> <files includes="${src.dir}/actors"/> @@ -2175,7 +2178,7 @@ DOCUMENTATION srcdir="${src.dir}/compiler" docRootContent="${src.dir}/compiler/rootdoc.txt" addparams="${scalac.args.all}" - implicits="on" diagrams="on"> + implicits="on" diagrams="on" rawOutput="${scaladoc.raw.output}"> <include name="**/*.scala"/> </scaladoc> <touch file="${build-docs.dir}/compiler.complete" verbose="no"/> @@ -2197,7 +2200,7 @@ DOCUMENTATION classpathref="pack.classpath" srcdir="${src.dir}/jline/src/main/java" addparams="${scalac.args.all}" - implicits="on" diagrams="on"> + implicits="on" diagrams="on" rawOutput="${scaladoc.raw.output}"> <include name="**/*.scala"/> <include name="**/*.java"/> </scaladoc> @@ -2221,7 +2224,7 @@ DOCUMENTATION classpathref="pack.classpath" srcdir="${src.dir}/scalap" addparams="${scalac.args.all}" - implicits="on" diagrams="on"> + implicits="on" diagrams="on" rawOutput="${scaladoc.raw.output}"> <include name="**/*.scala"/> </scaladoc> <touch file="${build-docs.dir}/scalap.complete" verbose="no"/> @@ -2243,7 +2246,7 @@ DOCUMENTATION classpathref="pack.classpath" srcdir="${src.dir}/partest" addparams="${scalac.args.all}" - implicits="on" diagrams="on"> + implicits="on" diagrams="on" rawOutput="${scaladoc.raw.output}"> <include name="**/*.scala"/> </scaladoc> <touch file="${build-docs.dir}/partest.complete" verbose="no"/> @@ -2265,7 +2268,7 @@ DOCUMENTATION classpathref="pack.classpath" srcdir="${src.dir}/continuations/plugin" addparams="${scalac.args.all}" - implicits="on" diagrams="on"> + implicits="on" diagrams="on" rawOutput="${scaladoc.raw.output}"> <include name="**/*.scala"/> </scaladoc> <touch file="${build-docs.dir}/continuations-plugin.complete" verbose="no"/> @@ -2287,7 +2290,7 @@ DOCUMENTATION classpathref="pack.classpath" srcdir="${src.dir}/actors-migration" addparams="${scalac.args.all}" - implicits="on" diagrams="on"> + implicits="on" diagrams="on" rawOutput="${scaladoc.raw.output}"> <include name="**/*.scala"/> </scaladoc> <touch file="${build-docs.dir}/actors-migration.complete" verbose="no"/> |