mix lazy_doc (lazy_doc v0.1.0)

Summary

Functions

Parameters

This should work for most of the modules, it will not work if the module contains only one function because Elixir does not create a __block__ node in this case.

write to given file the given Elixir AST This function does not write it in the proper format and it will remove comments as well

write to given file the given Elixir AST it writes formmated the string if the Elixir AST is annotated properly. if the AST is taken from a string you should use this options

Functions

docs_are_ok?(docs)

extract_names(ast)

Parameters

ast - an abstract syntax tree (AST) structure representing the source code. Description Initiates the extraction of names from the given AST.

Returns a list of names extracted from the AST.

insert_doc_for_function(ast, name_func, ast_doc)

This should work for most of the modules, it will not work if the module contains only one function because Elixir does not create a __block__ node in this case.

run(command_line_args)

Parameters

_command_line_args - command line arguments provided to the function. Description Runs the main application logic for the LazyDoc utility, processing source files to extract documentation.

Returns None

write_to_file(file, ast)

write to given file the given Elixir AST This function does not write it in the proper format and it will remove comments as well

write_to_file_formatted(file, ast, comments)

write to given file the given Elixir AST it writes formmated the string if the Elixir AST is annotated properly. if the AST is taken from a string you should use this options:

literalencoder: &{:ok, {:_block, &2, [&1]}}, token_metadata: true, unescape: false