Packages

template_generator

0.1.0
0.1.0

Elixir template generator

Current section

Files

Jump to
Readme
1 Version
0 Dependencies
0 Dependants
Files
Activity
template_generator doc Generator.Paths.html
Raw

doc/Generator.Paths.html 

<!DOCTYPE html>

<html lang="en">

  <head>

    <meta charset="utf-8">

    <meta http-equiv="x-ua-compatible" content="ie=edge">

    <meta name="viewport" content="width=device-width, initial-scale=1.0">

    <meta name="generator" content="ExDoc v0.28.3">

    <meta name="project" content="template_generator v0.1.0">



    <title>Generator.Paths — template_generator v0.1.0</title>

    <link rel="stylesheet" href="dist/elixir-d5ff82e6b0f5651c0ac0.css" />



    <script src="dist/sidebar_items-6bfb3178f9.js"></script>



      <script src="docs_config.js"></script>



    <script async src="dist/app-a088a6cc33ae3464193e.js"></script>





  </head>

  <body data-type="modules">

    <script>



      try {

        var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');



        if (settings.theme === 'dark' ||

           ((settings.theme === 'system' || settings.theme == null) &&

             window.matchMedia('(prefers-color-scheme: dark)').matches)

           ) {

          document.body.classList.add('dark')

        }

      } catch (error) { }

    </script>



<div class="main">





<section class="sidebar">

  <button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">

    <i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>

  </button>



  <form class="sidebar-search" action="search.html">

    <button type="submit" class="search-button" aria-label="Submit Search">

      <i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>

    </button>

    <button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">

      <i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>

    </button>

    <label class="search-label">

      <p class="sr-only">Search</p>

      <input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" />

    </label>

  </form>



  <div class="autocomplete">

    <div class="autocomplete-results">

    </div>

  </div>



  <div class="sidebar-header">



    <div class="sidebar-projectDetails">

      <a href="template_generator.html" class="sidebar-projectName" translate="no">

template_generator

      </a>

      <strong class="sidebar-projectVersion" translate="no">

        v0.1.0

      </strong>

    </div>

    <ul class="sidebar-listNav">

      <li><a id="extras-list-link" href="#full-list">Pages</a></li>



        <li><a id="modules-list-link" href="#full-list">Modules</a></li>





        <li><a id="tasks-list-link" href="#full-list"><span translate="no">Mix</span> Tasks</a></li>



    </ul>

  </div>



  <div class="gradient"></div>

  <ul id="full-list" class="sidebar-fullList"></ul>

</section>



<section class="content">

  <div class="content-outer">

    <div id="content" class="content-inner">



<h1>

<button class="settings display-settings">

  <i class="ri-settings-3-line"></i>

  <span class="sr-only">Settings</span>

</button>





    <a href="https://github.com/viniciuslcpereira97/template-generator/blob/main/lib/paths.ex#L1" title="View Source" class="view-source" rel="help">

      <i class="ri-code-s-slash-line" aria-hidden="true"></i>

      <span class="sr-only">View Source</span>

    </a>



  <span translate="no">Generator.Paths</span> 

  <small class="app-vsn" translate="no">(template_generator v0.1.0)</small>



</h1>





  <section id="moduledoc">

<p>Template generator paths context external API</p>

  </section>





  <section id="summary" class="details-list">

    <h1 class="section-heading">

      <a class="hover-link" href="#summary">

        <i class="ri-link-m" aria-hidden="true"></i>

        <span class="sr-only">Link to this section</span>

      </a>

      Summary

    </h1>



  <div class="summary-functions summary">

    <h2>

      <a href="#functions">Functions</a>

    </h2>



      <div class="summary-row">

        <div class="summary-signature">

          <a href="#create_from_template/1" translate="no">create_from_template(paths)</a>



        </div>



          <div class="summary-synopsis"><p>Creates all paths for the given project</p></div>



      </div>



      <div class="summary-row">

        <div class="summary-signature">

          <a href="#resolve_template_paths/1" translate="no">resolve_template_paths(template)</a>



        </div>



          <div class="summary-synopsis"><p>Resolves all template paths</p></div>



      </div>



  </div>



  </section>





  <section id="functions" class="details-list">

    <h1 class="section-heading">

      <a class="hover-link" href="#functions">

        <i class="ri-link-m" aria-hidden="true"></i>

        <span class="sr-only">Link to this section</span>

      </a>

Functions

    </h1>

    <div class="functions-list">

<section class="detail" id="create_from_template/1">



  <div class="detail-header">

    <a href="#create_from_template/1" class="detail-link" title="Link to this function">

      <i class="ri-link-m" aria-hidden="true"></i>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature" translate="no">create_from_template(paths)</h1>



      <a href="https://github.com/viniciuslcpereira97/template-generator/blob/main/lib/paths.ex#L23" class="view-source" rel="help" title="View Source">

       <i class="ri-code-s-slash-line" aria-hidden="true"></i>

       <span class="sr-only">View Source</span>

     </a>





  </div>



  <section class="docstring">



      <div class="specs">



          <pre translate="no"><span class="attribute">@spec</span> create_from_template(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()) :: :ok</pre>



      </div>



<p>Creates all paths for the given project</p>

  </section>

</section>

<section class="detail" id="resolve_template_paths/1">



  <div class="detail-header">

    <a href="#resolve_template_paths/1" class="detail-link" title="Link to this function">

      <i class="ri-link-m" aria-hidden="true"></i>

      <span class="sr-only">Link to this function</span>

    </a>

    <h1 class="signature" translate="no">resolve_template_paths(template)</h1>



      <a href="https://github.com/viniciuslcpereira97/template-generator/blob/main/lib/paths.ex#L16" class="view-source" rel="help" title="View Source">

       <i class="ri-code-s-slash-line" aria-hidden="true"></i>

       <span class="sr-only">View Source</span>

     </a>





  </div>



  <section class="docstring">



      <div class="specs">



          <pre translate="no"><span class="attribute">@spec</span> resolve_template_paths(<a href="Generator.Template.Schemas.Template.html#t:t/0">Generator.Template.Schemas.Template.t</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">any</a>()</pre>



      </div>



<p>Resolves all template paths</p>

  </section>

</section>



    </div>

  </section>



      <footer class="footer">



          <p>

            On Hex.pm:



            <span class="line">

              <a href="https://hex.pm/packages/template_generator/0.1.0" class="line footer-hex-package">Package</a>

              <a href="https://preview.hex.pm/preview/template_generator/0.1.0" class="line">Preview</a>



                <a href="https://preview.hex.pm/preview/template_generator/0.1.0/show/lib/paths.ex">(current file)</a>



            </span>



            <button class="line footer-button display-quick-switch">

              Search

            </button>

          </p>



        <p>

          Built using

          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.28.3) for the

          <a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>

        </p>

      </footer>

    </div>

  </div>

</section>

</div>





  </body>

</html>