Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
edoc_lib(3)		   Erlang Module Definition		   edoc_lib(3)

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 representation is not documented.

	 proplist() = proplists:property():

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

	      Types:

		 App = [] | atom()
		 Modules = [atom()]
		 proplist() = [term()]

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

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

       write_file(Text,	Dir, Name, Options) -> term()

SEE ALSO
       edoc

AUTHORS
       Richard Carlsson	_carlsson.richard@gmail.com_

				   edoc	0.10			   edoc_lib(3)

NAME | DESCRIPTION | DATA TYPES | EXPORTS | SEE ALSO | AUTHORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=edoc_lib&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help