GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  EDOC_LIB (3)

NAME

edoc_lib - Utility functions for EDoc.

CONTENTS

Description
Exports
Authors

DESCRIPTION

Utility functions for EDoc.

DATA TYPES

edoc_env():

Environment information needed by EDoc for generating references. The data representation is not documented.

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

EXPORTS

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

Types:

App = [] | atom()
Modules = [atom()]
[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

Search for    or go to Top of page |  Section 3 |  Main Index


EDOC_LIB (3) edoc 0.7.18

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.