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)

Check Out this Related Man Page

epp(3erl)						     Erlang Module Definition							 epp(3erl)

NAME

       epp - An Erlang Code Preprocessor

DESCRIPTION

       The  Erlang code preprocessor includes functions which are used by compile to preprocess macros and include files before the actual parsing
       takes place.

EXPORTS

       open(FileName, IncludePath) -> {ok,Epp} | {error, ErrorDescriptor}
       open(FileName, IncludePath, PredefMacros) -> {ok,Epp} | {error, ErrorDescriptor}

	      Types  FileName = atom() | string()
		     IncludePath = [DirectoryName]
		     DirectoryName = atom() | string()
		     PredefMacros = [{atom(),term()}]
		     Epp = pid() -- handle to the epp server
		     ErrorDescriptor = term()

	      Opens a file for preprocessing.

       close(Epp) -> ok

	      Types  Epp = pid() -- handle to the epp server

	      Closes the preprocessing of a file.

       parse_erl_form(Epp) -> {ok, AbsForm} | {eof, Line} | {error, ErrorInfo}

	      Types  Epp = pid()
		     AbsForm = term()
		     Line = integer()
		     ErrorInfo = see separate description below.

	      Returns the next Erlang form from the opened Erlang source file. The tuple {eof, Line} is returned at end-of-file.  The  first  form
	      corresponds to an implicit attribute -file(File,1). , where File is the name of the file.

       parse_file(FileName,IncludePath,PredefMacro) -> {ok,[Form]} | {error,OpenError}

	      Types  FileName = atom() | string()
		     IncludePath = [DirectoryName]
		     DirectoryName = atom() | string()
		     PredefMacros = [{atom(),term()}]
		     Form = term() -- same as returned by erl_parse:parse_form

	      Preprocesses and parses an Erlang source file. Note that the tuple {eof, Line} returned at end-of-file is included as a "form".

ERROR INFORMATION

       The ErrorInfo mentioned above is the standard ErrorInfo structure which is returned from all IO modules. It has the following format:

	   {ErrorLine, Module, ErrorDescriptor}

       A string which describes the error is obtained with the following call:

	   Module:format_error(ErrorDescriptor)

SEE ALSO

       erl_parse(3erl)

Ericsson AB							   stdlib 1.17.3							 epp(3erl)

Linux and UNIX Man Pages

edoc_doclet(3erl) [linux man page]

Check Out this Related Man Page