Packages

documentation_extractor

0.1.0

A package for extracting documentation from modules and their functions

HexDocs

Current section

Files

Jump to

Readme 1 Version 0 Dependencies Dependants Files Activity

documentation_extractor lib example_module.ex

Raw

lib/example_module.ex

defmodule ExampleModule do
  @moduledoc """
  A example module
  """

  @doc "Greets given name"
  def greet(name) do
    "Hello #{name}!"
  end

  @doc false
  def bye(name) do
    "Bye #{name}!"
  end
end

Search filters

Type any of these into the search box. They can be combined with free text which searches package names and descriptions.

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT

Wrap values in double quotes to include spaces, e.g. name:"my package".