<commit_before><?xml version="1.0" encoding="UTF-8"?>
<document>
  <properties>
    <title>Generating API with ScalaDoc</title>
    <authors>
      <person name="<NAME>" />
    </authors>
  </properties>
  <body>
    <h1>Generating API with ScalaDoc</h1>

    <span>Prerequis : <a href="usage.html">common usages</a></span>

    <section name="Configuration">
      <p>to generate apidocs / scaladoc for your scala sources, add this to your pom.xml</p>
      <source><![CDATA[
<project>
  ...
  <reporting>
    <plugins>
      ...
      <plugin>
        <groupId>org.scala-tools</groupId>
        <artifactId>maven-scala-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>]]></source>
    </section>
    <section name="To generate api">
      <p>
        Place scala sources files in :
        <source>src/main/scala</source>
      </p>
      <p>
        Then use the standard maven phases :
        <source>
          <![CDATA[
# generate a site
mvn site
       ]]>
        </source>
      </p>
      <p>
        Or the plugin specifics goal :
        <source>
          <![CDATA[
# generate only the doc
mvn scala:doc
        ]]>
        </source>
      </p>
      <p>See the result under target/site/scaladocs/</p>
    </section>
    <section name="To use a custom api generator">
      <p>
        You need to declare the main class to call (with the same parameter as scaladoc). And you need to list the additional artifact(jar) to use :
        <source>
        <configuration>
          <scaladocClassName>org.scala_tools.vscaladoc.Main</scaladocClassName>
          <scalaJars>
            <scalaJar>
              <groupId>org.scala-tools</groupId>
              <artifactId>vscaladoc</artifactId>
              <version>1.0</version>
            </scalaJar>
          </scalaJars>
        </configuration>
        </source>
      </p>
      <p>
        Then use the standard maven phases :
        <source>
          <![CDATA[
# generate a site
mvn site
# or generate only the doc
mvn scala:doc
       ]]>
        </source>
      </p>
      <p>See the result under target/site/scaladocs/</p>
    </section>
    <section name="To use vscaladoc">
      <p>
        vscaladoc have a shortcut way to use it (instead of using the custom way describe above) :
        <source>
        <configuration>
          <vscalaVersion>1.0</vscalaVersion>
        </configuration>
        </source>
      </p>
      <p>
        Then use the standard maven phases :
        <source>
          <![CDATA[
# generate a site
mvn site
# or generate only the doc
mvn scala:doc
       ]]>
        </source>
      </p>
      <p>See the result under target/site/scaladocs/</p>
    </section>
  </body>
</document>
<commit_msg>Fixed bug in site description not escaping XML<commit_after><?xml version="1.0" encoding="UTF-8"?>
<document>
  <properties>
    <title>Generating API with ScalaDoc</title>
    <authors>
      <person name="<NAME>" />
    </authors>
  </properties>
  <body>
    <h1>Generating API with ScalaDoc</h1>

    <span>Prerequis : <a href="usage.html">common usages</a></span>

    <section name="Configuration">
      <p>to generate apidocs / scaladoc for your scala sources, add this to your pom.xml</p>
      <source><![CDATA[
<project>
  ...
  <reporting>
    <plugins>
      ...
      <plugin>
        <groupId>org.scala-tools</groupId>
        <artifactId>maven-scala-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>]]></source>
    </section>
    <section name="To generate api">
      <p>
        Place scala sources files in :
        <source>src/main/scala</source>
      </p>
      <p>
        Then use the standard maven phases :
        <source>
          <![CDATA[
# generate a site
mvn site
       ]]>
        </source>
      </p>
      <p>
        Or the plugin specifics goal :
        <source>
          <![CDATA[
# generate only the doc
mvn scala:doc
        ]]>
        </source>
      </p>
      <p>See the result under target/site/scaladocs/</p>
    </section>
    <section name="To use a custom api generator">
      <p>
        You need to declare the main class to call (with the same parameter as scaladoc). And you need to list the additional artifact(jar) to use :
        <source>
        <configuration>
          <scaladocClassName>org.scala_tools.vscaladoc.Main</scaladocClassName>
          <scalaJars>
            <scalaJar>
              <groupId>org.scala-tools</groupId>
              <artifactId>vscaladoc</artifactId>
              <version>1.0</version>
            </scalaJar>
          </scalaJars>
        </configuration>
        </source>
      </p>
      <p>
        Then use the standard maven phases :
        <source>
          <![CDATA[
# generate a site
mvn site
# or generate only the doc
mvn scala:doc
       ]]>
        </source>
      </p>
      <p>See the result under target/site/scaladocs/</p>
    </section>
    <section name="To use vscaladoc">
      <p>
        vscaladoc have a shortcut way to use it (instead of using the custom way describe above) :        
        <source><![CDATA[
        <configuration>
          <vscalaVersion>1.0</vscalaVersion>
        </configuration>
        ]]></source>
      </p>
      <p>
        Then use the standard maven phases :
        <source>
          <![CDATA[
# generate a site
mvn site
# or generate only the doc
mvn scala:doc
       ]]>
        </source>
      </p>
      <p>See the result under target/site/scaladocs/</p>
    </section>
  </body>
</document>

{'fraction_non_alphanumeric': 0.13267326732673268, 'fraction_numerical': 0.0032403240324032404, 'mean_word_length': 1.90282131661442, 'pattern_counts': {'":': 0, '<': 204, '<?xml version=': 2, '>': 204, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 4}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2105580', 'n_tokens_mistral': 1814, 'n_tokens_neox': 1692, 'n_words': 473}