edoc_run(3erl)

🎀 edoc_run (3erl) 🎀

okay so bestie, welcome to the Erlang Module Definition for edoc_run 💖 — manual name is literally edoc_run, section 3erl, and it's the interface for calling EDoc from Erlang startup options. no cap, that's the whole vibe. 🦋

---

🌸 NAME 🌸

edoc_run — interface for calling EDoc from Erlang startup options. 💅

---

✨ DESCRIPTION ✨

okay so this module is the interface for calling EDoc from Erlang startup options. yes, the description says it twice — iconic of it, honestly. 👑

here's a typical Makefile usage moment, with the exact energy preserved:

            docs:
                    erl -noshell -run edoc_run application "'$(APP_NAME)'" \
                      '"."' '[{def,{vsn,"$(VSN)"}}]'

heads up bestie: note the single-quotes to avoid shell expansion, and the double-quotes enclosing the strings. 🔥

new feature in version 0.6.9: it is no longer necessary to write -s init stop last on the command line in order to make the execution terminate. the termination (signalling success or failure to the operating system) is now built into these functions. slay. ✨

---

🧚 DATA TYPES 🧚

• args() = [string()]:

---

💖 EXPORTS 💖

• application(Args::args()) -> no_return() — calls edoc:application/3 with the corresponding arguments. the strings in the list are parsed as Erlang constant terms. the list can be either [App], [App, Options] or [App, Dir, Options]. In the first case edoc:application/1 is called instead; in the second case, edoc:application/2 is called.

the function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system. 😭 that's a no-return situation, not a sad one.

• file(Args::args()) -> no_return() — > deprecated, bestie 🚨 — this function is deprecated: this is part of the old interface to EDoc and is mainly kept for backwards compatibility. the preferred way of generating documentation is through one of the functions application/1 and files/1.

calls edoc:file/2 with the corresponding arguments. the strings in the list are parsed as Erlang constant terms. the list can be either [File] or [File, Options]. In the first case, an empty list of options is passed to edoc:file/2.

the following is an example of typical usage in a Makefile:

                   $(DOCDIR)/%.html:%.erl
                           erl -noshell -run edoc_run file '"$<"' '[{dir,"$(DOCDIR)"}]' \
                             -s init stop

the function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system. 💀

• files(Args::args()) -> no_return() — calls edoc:files/2 with the corresponding arguments. the strings in the list are parsed as Erlang constant terms. the list can be either [Files] or [Files, Options]. In the first case, edoc:files/1 is called instead.

the function call never returns; instead, the emulator is automatically terminated when the call has completed, signalling success or failure to the operating system. 🌈

---

🦋 SEE ALSO 🦋

• edoc — go look at that one too, bestie. 💜

---

👑 AUTHORS 👑

• Richard Carlsson <carlsson.richard@gmail.com> — author royalty, fr fr. 🫶

---

mwah 💋 this was the edoc 1.2 version of the edoc_run(3erl) manual page — catch you in the docs, bestie 🍓🧚‍♀️