Module ec_vsn

Provides a signature to manage returning semver formatted versions from various version control repositories.

Copyright © 2014 Erlware, LLC.

This module defines the ec_vsn behaviour.
Required callback functions: new/0, vsn/1.

Authors: Eric Merritt (ericbmerritt@gmail.com).

Description

Provides a signature to manage returning semver formatted versions from various version control repositories.

This interface is a member of the Erlware Commons Library.

Data Types

t()

t() = #t{}

Function Index

behaviour_info/1
new/1create a new dictionary object from the specified module.
vsn/1Return the semver or an error depending on what is possible with this implementation in this directory.

Function Details

behaviour_info/1

behaviour_info(Other::atom()) -> [{atom(), arity()}] | undefined

new/1

new(ModuleName::module()) -> t()

ModuleName: The module name.

create a new dictionary object from the specified module. The module should implement the dictionary behaviour.

vsn/1

vsn(T::t()) -> {ok, string()} | {error, Reason::any()}

Return the semver or an error depending on what is possible with this implementation in this directory.


Generated by EDoc, May 1 2024, 06:09:58.