LazyDoc.Example (LazyDoc v0.6.2)

View Source

Documentation for LazyDoc.

This module is an example of autogenerated docs by the task provided.

Summary

Functions

Returns a message indicating a greeting.

Returns the atom :world.

Returns a description based on the input value.

Returns the string representation of the input number.

Functions

func_without_doc()

Returns a message indicating a greeting.

Parameters

  • None

Description

Executes a print statement to display "Hello world".

hello()

Returns the atom :world.

Parameters

  • None

Description

Returns a predefined atom value.

my_func(n)

Returns a description based on the input value.

Parameters

  • n - The input number to be described.

Description

Generates a string representation of the input number.

my_func_2(n)

Returns the string representation of the input number.

Parameters

  • n - an integer value.

Description

Returns a string indicating the value of n.