edoc_doclet(3erl) [linux man page]

edoc_doclet(3erl)					     Erlang Module Definition						 edoc_doclet(3erl)

NAME

       edoc_doclet - Standard doclet module for EDoc.

DESCRIPTION

       Standard doclet module for EDoc.

DATA TYPES

	 doclet_gen()	=   #doclet_gen{sources=[string()],   app=no_app()   |	 atom(),  packages=[atom()],  modules=[atom()],  modules=[atom()],
	 filemap=function()} :

	 doclet_toc() = #doclet_gen{paths=[string()], indir=string()} :

	 edoc_context() = #context{dir=string(), env=edoc_env() (see module edoc_lib), opts=[term()]} :

	 no_app() :

	   A value used to mark absence of an Erlang application context. Use the macro NO_APP defined in edoc_doclet.hrl to produce this value.

EXPORTS

       run(Command::doclet_gen() | doclet_toc(), Ctxt::edoc_context()) -> ok

	      Main doclet entry point. See the file edoc_doclet.hrl for the data structures used for passing parameters.

	      Also see edoc:layout/2 for layout-related options, and edoc:get_doc/2 for options related to reading source files.

	      Options:

		{file_suffix, string()} :
		  Specifies the suffix used for output files. The default value is ".html" .

		{hidden, boolean()} :
		  If the value is true , documentation of hidden modules and functions will also be included. The default value is false .

		{overview, edoc:filename()} :
		  Specifies the name of the overview-file. By default, this doclet looks for a file "overview.edoc" in the target directory.

		{private, boolean()} :
		  If the value is true , documentation of private modules and functions will also be included. The default value is false .

		{stylesheet, string()} :
		  Specifies the URI used for referencing the stylesheet. The default value is "stylesheet.css" . If an empty string is	specified,
		  no stylesheet reference will be generated.

		{stylesheet_file, edoc:filename()} :
		  Specifies  the  name	of the stylesheet file. By default, this doclet uses the file "stylesheet.css" in the priv subdirectory of
		  the EDoc installation directory. The named file will be copied to the target directory.

		{title, string()} :
		  Specifies the title of the overview-page.

SEE ALSO

       edoc

AUTHORS

       Richard Carlsson <richardc@it.uu.se >

								    edoc 0.7.7							 edoc_doclet(3erl)

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 ter-
       minate. 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 documentation 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 [Packages, 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)