read_doc v0.1.0 Tasks.ReadDoc

Abstract

Documentation of your project can be extracted into files containing markers.

These markers are

<!-- begin @doc <ElixirIdentifier> -->

to mark the start of an inserted docstriang and

<!-- end @doc <ElixirIdentifier> -->

to mark the end thereof.

Right now only @moduledoc and @doc strings can be extracted, according to if <ElixirIdentifier> refers to a module or a function.

E.g. if a file (typically README.md) contains the following content:

  Preface
  <!-- begin @doc: My.Module -->
     Some text
  <!-- end @doc: My.Module -->
  Epilogue

running

  mix read_doc README.md

will replace Some text with the moduledoc string of My.Module.

Limitations

  • Docstrings for types, macros and callbacks cannot be accessed yet.
  • Recursion is not supported, meaning that a docstring containing markers will not trigger the inclusion of the docstring indicated by these markers.

Link to this section Summary

Functions

This is the implementation interface of the task, it supports the following options

Link to this section Functions

Link to this function run(args)
run([String.t()]) :: :ok

This is the implementation interface of the task, it supports the following options: