👤
Home Man
Search
Today's Posts
Register

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:
Select Section of Man Page:
Select Man Page Repository:

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

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)


All times are GMT -4. The time now is 01:32 PM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
×
UNIX.COM Login
Username:
Password:  
Show Password