{ "args": [ "list" ], "branch_name": "master", "client_name": "inch_ex", "client_version": "0.3.3", "git_repo_url": "https://github.com/inch-ci/Hello-World-Elixir.git", "language": "elixir", "objects": [ { "id": "InchTest", "module": "Elixir.InchTest", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test.ex:1", "type": null }, { "id": "InchTest.Callbacks", "module": "Elixir.InchTest.Callbacks", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/callbacks.ex:1", "type": "behaviour" }, { "id": "InchTest.CodeExamples", "module": "Elixir.InchTest.CodeExamples", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/code_examples.ex:1", "type": null }, { "id": "InchTest.Config", "module": "Elixir.InchTest.Config", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test.ex:2", "type": null }, { "id": "InchTest.Docs.Formatter", "module": "Elixir.InchTest.Docs.Formatter", "moduledoc": "Provide JSON-formatted documentation\n", "object_type": "ModuleObject", "source": "lib/inch_test/docs/formatter.ex:3", "type": null }, { "id": "InchTest.Docs.Retriever", "module": "Elixir.InchTest.Docs.Retriever", "moduledoc": "Functions to extract documentation information from modules.\n", "object_type": "ModuleObject", "source": "lib/inch_test/docs/retriever.ex:24", "type": null }, { "id": "InchTest.Docs.Retriever.Error", "module": "Elixir.InchTest.Docs.Retriever.Error", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/docs/retriever.ex:20", "type": "exception" }, { "id": "InchTest.FunctionObject", "module": "Elixir.InchTest.FunctionObject", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/docs/retriever.ex:10", "type": null }, { "id": "InchTest.Functions", "module": "Elixir.InchTest.Functions", "moduledoc": " In this module we define funs that are \"cases\" for our test suite.\n", "object_type": "ModuleObject", "source": "lib/inch_test/functions.ex:1", "type": null }, { "id": "InchTest.Html", "module": "Elixir.InchTest.Html", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/html.ex:3", "type": null }, { "id": "InchTest.Html.Safe", "module": "Elixir.InchTest.Html.Safe", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/html.ex:19", "type": "protocol" }, { "id": "InchTest.Html.Safe.Atom", "module": "Elixir.InchTest.Html.Safe.Atom", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/html.ex:23", "type": "impl" }, { "id": "InchTest.Html.Safe.BitString", "module": "Elixir.InchTest.Html.Safe.BitString", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/html.ex:28", "type": "impl" }, { "id": "InchTest.Html.Safe.Float", "module": "Elixir.InchTest.Html.Safe.Float", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/html.ex:66", "type": "impl" }, { "id": "InchTest.Html.Safe.Integer", "module": "Elixir.InchTest.Html.Safe.Integer", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/html.ex:62", "type": "impl" }, { "id": "InchTest.Html.Safe.List", "module": "Elixir.InchTest.Html.Safe.List", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/html.ex:34", "type": "impl" }, { "id": "InchTest.Html.Safe.Tuple", "module": "Elixir.InchTest.Html.Safe.Tuple", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/html.ex:72", "type": "impl" }, { "id": "InchTest.Macros", "module": "Elixir.InchTest.Macros", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/macros.ex:1", "type": null }, { "id": "InchTest.ModuleObject", "module": "Elixir.InchTest.ModuleObject", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/docs/retriever.ex:5", "type": null }, { "id": "InchTest.Naming", "module": "Elixir.InchTest.Naming", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/naming.ex:3", "type": null }, { "id": "InchTest.TypeObject", "module": "Elixir.InchTest.TypeObject", "moduledoc": null, "object_type": "ModuleObject", "source": "lib/inch_test/docs/retriever.ex:15", "type": null }, { "arity": 4, "doc": false, "id": "generate_docs/4", "module_id": "InchTest", "name": "generate_docs", "object_type": "FunctionObject", "signature": [ [ "project", [], null ], [ "version", [], null ], [ "args", [], null ], [ "options", [], null ] ], "source": "lib/inch_test.ex:12", "type": "def" }, { "arity": 1, "doc": "Informs the given message.\n", "id": "full_doc/1", "module_id": "InchTest.Callbacks", "name": "full_doc", "object_type": "FunctionObject", "signature": null, "source": "lib/inch_test/callbacks.ex:7", "type": "defcallback" }, { "arity": 1, "doc": null, "id": "missing_doc/1", "module_id": "InchTest.Callbacks", "name": "missing_doc", "object_type": "FunctionObject", "signature": null, "source": "lib/inch_test/callbacks.ex:12", "type": "defcallback" }, { "arity": 1, "doc": false, "id": "no_doc/1", "module_id": "InchTest.Callbacks", "name": "no_doc", "object_type": "FunctionObject", "signature": null, "source": "lib/inch_test/callbacks.ex:10", "type": "defcallback" }, { "arity": 1, "doc": false, "id": "__behaviour__/1", "module_id": "InchTest.Callbacks", "name": "__behaviour__", "object_type": "FunctionObject", "signature": [ [ "atom1", [], "Elixir" ] ], "source": "lib/inch_test/callbacks.ex:1", "type": "def" }, { "arity": 0, "doc": "Converts String to underscore case\n\n## Examples\n\n iex> InchTest.Naming.underscore(\"MyApp\")\n \"my_app\"\n\n iex> InchTest.Naming.underscore(\"my-app\")\n \"my_app\"\n\nIn general, `underscore` can be thought of as the reverse of\n`camelize`, however, in some cases formatting may be lost:\n\n Naming.underscore \"SAPExample\" #=> \"sap_example\"\n Naming.camelize \"sap_example\" #=> \"SapExample\"\n\n", "id": "multiple_code_examples/0", "module_id": "InchTest.CodeExamples", "name": "multiple_code_examples", "object_type": "FunctionObject", "signature": [], "source": "lib/inch_test/code_examples.ex:33", "type": "def" }, { "arity": 0, "doc": "Extracts the resource name from an alias\n\n## Examples\n\n iex> InchTest.Naming.resource_name(MyApp.User)\n \"user\"\n iex> InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n \"user\"\n", "id": "single_code_example/0", "module_id": "InchTest.CodeExamples", "name": "single_code_example", "object_type": "FunctionObject", "signature": [], "source": "lib/inch_test/code_examples.ex:12", "type": "def" }, { "arity": 3, "doc": "Generate JSON documentation for the given modules\n", "id": "run/3", "module_id": "InchTest.Docs.Formatter", "name": "run", "object_type": "FunctionObject", "signature": [ [ "modules", [], null ], [ "args", [], null ], [ "config", [], null ] ], "source": "lib/inch_test/docs/formatter.ex:11", "type": "def" }, { "arity": 2, "doc": "Extract documentation from all modules in the specified directory\n", "id": "docs_from_dir/2", "module_id": "InchTest.Docs.Retriever", "name": "docs_from_dir", "object_type": "FunctionObject", "signature": [ [ "dir", [], null ], [ "config", [], null ] ], "source": "lib/inch_test/docs/retriever.ex:32", "type": "def" }, { "arity": 2, "doc": "Extract documentation from all modules in the specified list of files\n", "id": "docs_from_files/2", "module_id": "InchTest.Docs.Retriever", "name": "docs_from_files", "object_type": "FunctionObject", "signature": [ [ "files", [], null ], [ "config", [], null ] ], "source": "lib/inch_test/docs/retriever.ex:38", "type": "def" }, { "arity": 2, "doc": "Extract documentation from all modules in the list `modules`\n", "id": "docs_from_modules/2", "module_id": "InchTest.Docs.Retriever", "name": "docs_from_modules", "object_type": "FunctionObject", "signature": [ [ "modules", [], null ], [ "config", [], null ] ], "source": "lib/inch_test/docs/retriever.ex:44", "type": "def" }, { "arity": 1, "doc": false, "id": "exception/1", "module_id": "InchTest.Docs.Retriever.Error", "name": "exception", "object_type": "FunctionObject", "signature": [ [ "args", [], null ] ], "source": "lib/inch_test/docs/retriever.ex:21", "type": "def" }, { "arity": 1, "doc": false, "id": "message/1", "module_id": "InchTest.Docs.Retriever.Error", "name": "message", "object_type": "FunctionObject", "signature": [ [ "exception", [], null ] ], "source": "lib/inch_test/docs/retriever.ex:21", "type": "def" }, { "arity": 2, "doc": "This fun takes `param1` and `param2` as arguments.\n\n## Examples\n\n iex> InchTest.Naming.resource_name(MyApp.User)\n \"user\"\n iex> InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n \"user\"\n", "id": "full_doc/2", "module_id": "InchTest.Functions", "name": "full_doc", "object_type": "FunctionObject", "signature": [ [ "param1", [], null ], [ "param2", [], null ] ], "source": "lib/inch_test/functions.ex:16", "type": "def" }, { "arity": 2, "doc": "This fun takes a `param1` and a second parameter that is never used\n(maybe, because it is a callback or something like that). However, the\nsecond param should impact the evaluation by Inch.\n\n## Examples\n\n iex> InchTest.Naming.resource_name(MyApp.User)\n \"user\"\n iex> InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n \"user\"\n", "id": "full_doc_second_parameter_unnamed/2", "module_id": "InchTest.Functions", "name": "full_doc_second_parameter_unnamed", "object_type": "FunctionObject", "signature": [ [ "param1", [], null ], [ "", [], "Elixir" ] ], "source": "lib/inch_test/functions.ex:31", "type": "def" }, { "arity": 1, "doc": null, "id": "escape/1", "module_id": "InchTest.Html", "name": "escape", "object_type": "FunctionObject", "signature": [ [ "buffer", [], null ] ], "source": "lib/inch_test/html.ex:76", "type": "def" }, { "arity": 1, "doc": null, "id": "safe/1", "module_id": "InchTest.Html", "name": "safe", "object_type": "FunctionObject", "signature": [ [ "value", [], null ] ], "source": "lib/inch_test/html.ex:14", "type": "def" }, { "arity": 1, "doc": null, "id": "unsafe/1", "module_id": "InchTest.Html", "name": "unsafe", "object_type": "FunctionObject", "signature": [ [ "value", [], null ] ], "source": "lib/inch_test/html.ex:16", "type": "def" }, { "arity": 1, "doc": false, "id": "__protocol__/1", "module_id": "InchTest.Html.Safe", "name": "__protocol__", "object_type": "FunctionObject", "signature": [ [ "atom1", [], "Elixir" ] ], "source": "lib/inch_test/html.ex:19", "type": "def" }, { "arity": 1, "doc": null, "id": "to_string/1", "module_id": "InchTest.Html.Safe", "name": "to_string", "object_type": "FunctionObject", "signature": [ [ "data", [], null ] ], "source": "lib/inch_test/html.ex:20", "type": "def" }, { "arity": 1, "doc": false, "id": "__impl__/1", "module_id": "InchTest.Html.Safe.Atom", "name": "__impl__", "object_type": "FunctionObject", "signature": [ [ "atom1", [], "Elixir" ] ], "source": "lib/inch_test/html.ex:23", "type": "def" }, { "arity": 1, "doc": false, "id": "to_string/1", "module_id": "InchTest.Html.Safe.Atom", "name": "to_string", "object_type": "FunctionObject", "signature": [ [ "atom", [], null ] ], "source": "lib/inch_test/html.ex:24", "type": "def" }, { "arity": 1, "doc": false, "id": "__impl__/1", "module_id": "InchTest.Html.Safe.BitString", "name": "__impl__", "object_type": "FunctionObject", "signature": [ [ "atom1", [], "Elixir" ] ], "source": "lib/inch_test/html.ex:28", "type": "def" }, { "arity": 1, "doc": false, "id": "to_string/1", "module_id": "InchTest.Html.Safe.BitString", "name": "to_string", "object_type": "FunctionObject", "signature": [ [ "data", [], null ] ], "source": "lib/inch_test/html.ex:29", "type": "def" }, { "arity": 1, "doc": false, "id": "__impl__/1", "module_id": "InchTest.Html.Safe.Float", "name": "__impl__", "object_type": "FunctionObject", "signature": [ [ "atom1", [], "Elixir" ] ], "source": "lib/inch_test/html.ex:66", "type": "def" }, { "arity": 1, "doc": false, "id": "to_string/1", "module_id": "InchTest.Html.Safe.Float", "name": "to_string", "object_type": "FunctionObject", "signature": [ [ "data", [], null ] ], "source": "lib/inch_test/html.ex:67", "type": "def" }, { "arity": 1, "doc": false, "id": "__impl__/1", "module_id": "InchTest.Html.Safe.Integer", "name": "__impl__", "object_type": "FunctionObject", "signature": [ [ "atom1", [], "Elixir" ] ], "source": "lib/inch_test/html.ex:62", "type": "def" }, { "arity": 1, "doc": false, "id": "to_string/1", "module_id": "InchTest.Html.Safe.Integer", "name": "to_string", "object_type": "FunctionObject", "signature": [ [ "data", [], null ] ], "source": "lib/inch_test/html.ex:63", "type": "def" }, { "arity": 1, "doc": false, "id": "__impl__/1", "module_id": "InchTest.Html.Safe.List", "name": "__impl__", "object_type": "FunctionObject", "signature": [ [ "atom1", [], "Elixir" ] ], "source": "lib/inch_test/html.ex:34", "type": "def" }, { "arity": 1, "doc": false, "id": "to_string/1", "module_id": "InchTest.Html.Safe.List", "name": "to_string", "object_type": "FunctionObject", "signature": [ [ "list", [], null ] ], "source": "lib/inch_test/html.ex:35", "type": "def" }, { "arity": 1, "doc": false, "id": "__impl__/1", "module_id": "InchTest.Html.Safe.Tuple", "name": "__impl__", "object_type": "FunctionObject", "signature": [ [ "atom1", [], "Elixir" ] ], "source": "lib/inch_test/html.ex:72", "type": "def" }, { "arity": 1, "doc": false, "id": "to_string/1", "module_id": "InchTest.Html.Safe.Tuple", "name": "to_string", "object_type": "FunctionObject", "signature": [ [ "arg1", [], "Elixir" ] ], "source": "lib/inch_test/html.ex:73", "type": "def" }, { "arity": 0, "doc": "Another example", "id": "full_doc/0", "module_id": "InchTest.Macros", "name": "full_doc", "object_type": "FunctionObject", "signature": [], "source": "lib/inch_test/macros.ex:3", "type": "defmacro" }, { "arity": 0, "doc": null, "id": "missing_doc/0", "module_id": "InchTest.Macros", "name": "missing_doc", "object_type": "FunctionObject", "signature": [], "source": "lib/inch_test/macros.ex:8", "type": "defmacro" }, { "arity": 0, "doc": false, "id": "no_doc/0", "module_id": "InchTest.Macros", "name": "no_doc", "object_type": "FunctionObject", "signature": [], "source": "lib/inch_test/macros.ex:6", "type": "defmacro" }, { "arity": 1, "doc": "Converts String to camel case\n\n## Examples\n\n iex> InchTest.Naming.camelize(\"my_app\")\n \"MyApp\"\n\nIn general, `camelize` can be thought of as the reverse of\n`underscore`, however, in some cases formatting may be lost:\n\n InchTest.Naming.underscore \"SAPExample\" #=> \"sap_example\"\n InchTest.Naming.camelize \"sap_example\" #=> \"SapExample\"\n\n", "id": "camelize/1", "module_id": "InchTest.Naming", "name": "camelize", "object_type": "FunctionObject", "signature": [ [ "arg1", [], "Elixir" ] ], "source": "lib/inch_test/naming.ex:106", "type": "def" }, { "arity": 1, "doc": null, "id": "do_camelize/1", "module_id": "InchTest.Naming", "name": "do_camelize", "object_type": "FunctionObject", "signature": [ [ "arg1", [], "Elixir" ] ], "source": "lib/inch_test/naming.ex:116", "type": "def" }, { "arity": 2, "doc": null, "id": "do_underscore/2", "module_id": "InchTest.Naming", "name": "do_underscore", "object_type": "FunctionObject", "signature": [ [ "arg1", [], "Elixir" ], [ "prev", [], null ] ], "source": "lib/inch_test/naming.ex:58", "type": "def" }, { "arity": 2, "doc": null, "id": "remove_suffix/2", "module_id": "InchTest.Naming", "name": "remove_suffix", "object_type": "FunctionObject", "signature": [ [ "alias", [], null ], [ "suffix", [], null ] ], "source": "lib/inch_test/naming.ex:23", "type": "def" }, { "arity": 2, "doc": "Extracts the resource name from an alias\n\n## Examples\n\n iex> InchTest.Naming.resource_name(MyApp.User)\n \"user\"\n iex> InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n \"user\"\n\n", "id": "resource_name/2", "module_id": "InchTest.Naming", "name": "resource_name", "object_type": "FunctionObject", "signature": [ [ "alias", [], null ], [ "\\\\", [], [ [ "suffix", [], null ], null ] ] ], "source": "lib/inch_test/naming.ex:15", "type": "def" }, { "arity": 1, "doc": null, "id": "to_lower_char/1", "module_id": "InchTest.Naming", "name": "to_lower_char", "object_type": "FunctionObject", "signature": [ [ "char", [], null ] ], "source": "lib/inch_test/naming.ex:88", "type": "def" }, { "arity": 1, "doc": null, "id": "to_upper_char/1", "module_id": "InchTest.Naming", "name": "to_upper_char", "object_type": "FunctionObject", "signature": [ [ "char", [], null ] ], "source": "lib/inch_test/naming.ex:140", "type": "def" }, { "arity": 1, "doc": "Converts String to underscore case\n\n## Examples\n\n iex> InchTest.Naming.underscore(\"MyApp\")\n \"my_app\"\n\n iex> InchTest.Naming.underscore(\"my-app\")\n \"my_app\"\n\nIn general, `underscore` can be thought of as the reverse of\n`camelize`, however, in some cases formatting may be lost:\n\n Naming.underscore \"SAPExample\" #=> \"sap_example\"\n Naming.camelize \"sap_example\" #=> \"SapExample\"\n\n", "id": "underscore/1", "module_id": "InchTest.Naming", "name": "underscore", "object_type": "FunctionObject", "signature": [ [ "arg1", [], "Elixir" ] ], "source": "lib/inch_test/naming.ex:52", "type": "def" } ], "revision": "2f0554fbb54c81e4869a391c264735c95dd1c460", "shell": true }