<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE comref SYSTEM "comref.dtd">

<comref>
  <header>
    <copyright>
      <year>2020</year><year>2021</year>
      <holder>Ericsson AB. All Rights Reserved.</holder>
    </copyright>
    <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    </legalnotice>

    <title>EDoc command line interface</title>
    <prepared></prepared>
    <responsible></responsible>
    <docno></docno>
    <approved></approved>
    <checked></checked>
    <date>2020-12-22</date>
    <rev></rev>
    <file>edoc_cmd.xml</file>
  </header>
  <com>edoc_cmd</com>
  <comsummary>EDoc command line interface EScript.
  </comsummary>

  <description>
    <p>This script is a command line entry point to both
    <seemfa marker="edoc#application/2">edoc:application/2</seemfa> and
    <seemfa marker="edoc#files/2">edoc:files/2</seemfa> functions.
    It also allows to generate just the EEP-48 doc chunks (using the <c>-chunks</c> flag)
    instead of the complete HTML documentation.</p>
  </description>

  <funcs>
    <func>
      <name>edoc -app &lt;app&gt; [-chunks]</name>
      <fsummary>Run EDoc on application &lt;app&gt;.</fsummary>
      <desc>
        <p>EDoc is invoked via <c>edoc:application/2</c>, with the default set of options.
        If <c>-chunks</c> is given, then only doc chunks will be generated,
        not the full HTML documentation.</p>
        <p>Run the script with no arguments to get the full list of options.</p>
      </desc>
    </func>
    <func>
      <name>edoc -files &lt;erl_file&gt;... [-chunks]</name>
      <fsummary>Run EDoc on the given Erlang source files.</fsummary>
      <desc>
        <p>EDoc is invoked via <c>edoc:files/2</c>, with the default set of options.
        If <c>-chunks</c> is given, then only doc chunks will be generated,
        not the full HTML documentation.</p>
        <p>Run the script with no arguments to get the full list of options.</p>
      </desc>
    </func>
  </funcs>

</comref>
