Unix/Linux Go Back    


Linux 2.6 - man page for edoc_run (linux section 3erl)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)


edoc_run(3erl)			     Erlang Module Definition			   edoc_run(3erl)

NAME
       edoc_run - Interface for calling EDoc from Erlang startup options.

DESCRIPTION
       Interface for calling EDoc from Erlang startup options.

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

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

       (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.

EXPORTS
       application(Args::[string()]) -> none()

	      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.

       file(Args::[string()]) -> none()

	      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 documenta-
	      tion is through one of the functions application/1 , packages/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::[string()]) -> none()

	      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.

       packages(Args::[string()]) -> none()

	      Calls edoc:application/2 with the corresponding arguments. The strings in the  list
	      are  parsed  as  Erlang constant terms. The list can be either [Packages] or [Pack-
	      ages, Options] . In the first case edoc:application/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

AUTHORS
       Richard Carlsson <richardc@it.uu.se >

					    edoc 0.7.7				   edoc_run(3erl)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums


All times are GMT -4. The time now is 09:00 AM.