Unix/Linux Go Back    


Linux 2.6 - man page for edoc_lib (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_lib(3erl)			     Erlang Module Definition			   edoc_lib(3erl)

NAME
       edoc_lib - Utility functions for EDoc.

DESCRIPTION
       Utility functions for EDoc.

DATA TYPES
	 edoc_env() :

	   Environment information needed by EDoc for generating references. The data representa-
	   tion is not documented.

	 proplist() = property() (see module proplists) :

EXPORTS
       get_doc_env(App, Packages, Modules, Options::proplist()) -> edoc_env()

	      Types  App = [] | atom()
		     Packages = [atom()]
		     Modules = [atom()]
		     [term()]

	      Creates an environment data structure used by parts of EDoc for  generating  refer-
	      ences,  etc.  See  edoc:run/3  for  a  description  of  the  options  file_suffix ,
	      app_default and doc_path .

	      See also: edoc:get_doc/3 , edoc_extract:source/4 .

SEE ALSO
       edoc

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

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


All times are GMT -4. The time now is 10:11 PM.